Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.
", - "operations":{ - "AttachInstances":{ - "name":"AttachInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachInstancesQuery"}, - "documentation":"Attaches one or more EC2 instances to the specified Auto Scaling group.
For more information, see Attach Amazon EC2 Instances to Your Existing Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "CompleteLifecycleAction":{ - "name":"CompleteLifecycleAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CompleteLifecycleActionType"}, - "output":{ - "shape":"CompleteLifecycleActionAnswer", - "resultWrapper":"CompleteLifecycleActionResult" - }, - "documentation":"Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.
" - }, - "CreateAutoScalingGroup":{ - "name":"CreateAutoScalingGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAutoScalingGroupType"}, - "errors":[ - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have an Auto Scaling group or launch configuration with this name.
" - }, - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - } - ], - "documentation":"Creates an Auto Scaling group with the specified name and attributes.
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 these limits, see DescribeAccountLimits.
" - }, - "CreateLaunchConfiguration":{ - "name":"CreateLaunchConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLaunchConfigurationType"}, - "errors":[ - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have an Auto Scaling group or launch configuration with this name.
" - }, - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - } - ], - "documentation":"Creates a launch configuration.
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 these limits, see DescribeAccountLimits.
" - }, - "CreateOrUpdateTags":{ - "name":"CreateOrUpdateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateOrUpdateTagsType"}, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - }, - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have an Auto Scaling group or launch configuration with this name.
" - } - ], - "documentation":"Creates or updates tags for the specified Auto Scaling group.
For more information, see Add, Modify, or Remove Auto Scaling Group Tags in the Auto Scaling Developer Guide.
" - }, - "DeleteAutoScalingGroup":{ - "name":"DeleteAutoScalingGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAutoScalingGroupType"}, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group can't be deleted because there are scaling activities in progress.
" - }, - { - "shape":"ResourceInUseFault", - "error":{ - "code":"ResourceInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group or launch configuration can't be deleted because it is in use.
" - } - ], - "documentation":"Deletes the specified Auto Scaling group.
The group must have no instances and no scaling activities in progress.
To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and maximum size of the AutoScalingGroup to zero.
" - }, - "DeleteLaunchConfiguration":{ - "name":"DeleteLaunchConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"LaunchConfigurationNameType"}, - "errors":[ - { - "shape":"ResourceInUseFault", - "error":{ - "code":"ResourceInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group or launch configuration can't be deleted because it is in use.
" - } - ], - "documentation":"Deletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
" - }, - "DeleteLifecycleHook":{ - "name":"DeleteLifecycleHook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLifecycleHookType"}, - "output":{ - "shape":"DeleteLifecycleHookAnswer", - "resultWrapper":"DeleteLifecycleHookResult" - }, - "documentation":"Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
Deletes the specified notification.
" - }, - "DeletePolicy":{ - "name":"DeletePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeletePolicyType", - "documentation":"" - }, - "documentation":"Deletes the specified Auto Scaling policy.
" - }, - "DeleteScheduledAction":{ - "name":"DeleteScheduledAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteScheduledActionType"}, - "documentation":"Deletes the specified scheduled action.
" - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTagsType"}, - "documentation":"Deletes the specified tags.
" - }, - "DescribeAccountLimits":{ - "name":"DescribeAccountLimits", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeAccountLimitsAnswer", - "resultWrapper":"DescribeAccountLimitsResult" - }, - "documentation":"Describes the current Auto Scaling resource limits for your AWS account.
For information about requesting an increase in these limits, see AWS Service Limits.
" - }, - "DescribeAdjustmentTypes":{ - "name":"DescribeAdjustmentTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeAdjustmentTypesAnswer", - "resultWrapper":"DescribeAdjustmentTypesResult" - }, - "documentation":"Lists the policy adjustment types for use with PutScalingPolicy.
" - }, - "DescribeAutoScalingGroups":{ - "name":"DescribeAutoScalingGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AutoScalingGroupNamesType"}, - "output":{ - "shape":"AutoScalingGroupsType", - "resultWrapper":"DescribeAutoScalingGroupsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The NextToken value is not valid.
Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
You can specify a maximum number of items to be returned with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.
The NextToken value is not valid.
Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
You can describe up to a maximum of 50 instances with a single call. By default, a call returns up to 20 instances. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.
Lists the notification types that are supported by Auto Scaling.
" - }, - "DescribeLaunchConfigurations":{ - "name":"DescribeLaunchConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"LaunchConfigurationNamesType"}, - "output":{ - "shape":"LaunchConfigurationsType", - "resultWrapper":"DescribeLaunchConfigurationsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The NextToken value is not valid.
Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
You can specify a maximum number of items to be returned with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.
Describes the available types of lifecycle hooks.
" - }, - "DescribeLifecycleHooks":{ - "name":"DescribeLifecycleHooks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLifecycleHooksType"}, - "output":{ - "shape":"DescribeLifecycleHooksAnswer", - "resultWrapper":"DescribeLifecycleHooksResult" - }, - "documentation":"Describes the lifecycle hooks for the specified Auto Scaling group.
" - }, - "DescribeMetricCollectionTypes":{ - "name":"DescribeMetricCollectionTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeMetricCollectionTypesAnswer", - "resultWrapper":"DescribeMetricCollectionTypesResult" - }, - "documentation":"Returns a list of metrics and a corresponding list of granularities for each metric.
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
The NextToken value is not valid.
Describes the notification actions associated with the specified Auto Scaling group.
" - }, - "DescribePolicies":{ - "name":"DescribePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePoliciesType"}, - "output":{ - "shape":"PoliciesType", - "resultWrapper":"DescribePoliciesResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The NextToken value is not valid.
Describes the policies for the specified Auto Scaling group.
You can specify a maximum number of items to be returned with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.
The NextToken value is not valid.
Describes one or more scaling activities for the specified Auto Scaling group. If you omit the ActivityIds, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.
You can specify a maximum number of items to be returned with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
" - }, - "DescribeScheduledActions":{ - "name":"DescribeScheduledActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeScheduledActionsType"}, - "output":{ - "shape":"ScheduledActionsType", - "resultWrapper":"DescribeScheduledActionsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The NextToken value is not valid.
Lists the actions scheduled for your Auto Scaling group that haven't been executed. To list the actions that were already executed, use DescribeScalingActivities.
" - }, - "DescribeTags":{ - "name":"DescribeTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTagsType"}, - "output":{ - "shape":"TagsType", - "resultWrapper":"DescribeTagsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The NextToken value is not valid.
Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
" - }, - "DescribeTerminationPolicyTypes":{ - "name":"DescribeTerminationPolicyTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeTerminationPolicyTypesAnswer", - "resultWrapper":"DescribeTerminationPolicyTypesResult" - }, - "documentation":"Lists the termination policies supported by Auto Scaling.
" - }, - "DetachInstances":{ - "name":"DetachInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachInstancesQuery"}, - "output":{ - "shape":"DetachInstancesAnswer", - "resultWrapper":"DetachInstancesResult" - }, - "documentation":"Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "DisableMetricsCollection":{ - "name":"DisableMetricsCollection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableMetricsCollectionQuery"}, - "documentation":"Disables monitoring of the specified metrics for the specified Auto Scaling group.
" - }, - "EnableMetricsCollection":{ - "name":"EnableMetricsCollection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableMetricsCollectionQuery"}, - "documentation":"Enables monitoring of the specified metrics for the specified Auto Scaling group.
You can only enable metrics collection if InstanceMonitoring in the launch configuration for the group is set to True.
Moves the specified instances into Standby mode.
For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide.
" - }, - "ExecutePolicy":{ - "name":"ExecutePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ExecutePolicyType"}, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group can't be deleted because there are scaling activities in progress.
" - } - ], - "documentation":"Executes the specified policy.
" - }, - "ExitStandby":{ - "name":"ExitStandby", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ExitStandbyQuery"}, - "output":{ - "shape":"ExitStandbyAnswer", - "resultWrapper":"ExitStandbyResult" - }, - "documentation":"Moves the specified instances out of Standby mode.
For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide.
" - }, - "PutLifecycleHook":{ - "name":"PutLifecycleHook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutLifecycleHookType"}, - "output":{ - "shape":"PutLifecycleHookAnswer", - "resultWrapper":"PutLifecycleHookResult" - }, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - } - ], - "documentation":"Creates or updates a lifecycle hook for the specified Auto Scaling Group.
A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.
" - }, - "PutNotificationConfiguration":{ - "name":"PutNotificationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutNotificationConfigurationType"}, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - } - ], - "documentation":"Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.
For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide.
This configuration overwrites an existing configuration.
" - }, - "PutScalingPolicy":{ - "name":"PutScalingPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutScalingPolicyType"}, - "output":{ - "shape":"PolicyARNType", - "resultWrapper":"PutScalingPolicyResult" - }, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - } - ], - "documentation":"Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
" - }, - "PutScheduledUpdateGroupAction":{ - "name":"PutScheduledUpdateGroupAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutScheduledUpdateGroupActionType"}, - "errors":[ - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have an Auto Scaling group or launch configuration with this name.
" - }, - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - } - ], - "documentation":"Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.
For more information, see Scheduled Scaling in the Auto Scaling Developer Guide.
Auto Scaling supports the date and time expressed in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only.
Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of PutLifecycleHook.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.
" - }, - "ResumeProcesses":{ - "name":"ResumeProcesses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ScalingProcessQuery"}, - "documentation":"Resumes the specified suspended Auto Scaling processes for the specified Auto Scaling group. To resume specific processes, use the ScalingProcesses parameter. To resume all processes, omit the ScalingProcesses parameter. For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide.
The Auto Scaling group can't be deleted because there are scaling activities in progress.
" - } - ], - "documentation":"Sets the size of the specified AutoScalingGroup.
" - }, - "SetInstanceHealth":{ - "name":"SetInstanceHealth", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetInstanceHealthQuery"}, - "documentation":"Sets the health status of the specified instance.
For more information, see Health Checks in the Auto Scaling Developer Guide.
" - }, - "SuspendProcesses":{ - "name":"SuspendProcesses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ScalingProcessQuery"}, - "documentation":"Suspends the specified Auto Scaling processes for the specified Auto Scaling group. To suspend specific processes, use the ScalingProcesses parameter. To suspend all processes, omit the ScalingProcesses parameter.
Note that if you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.
To resume processes that have been suspended, use ResumeProcesses.
For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide.
" - }, - "TerminateInstanceInAutoScalingGroup":{ - "name":"TerminateInstanceInAutoScalingGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TerminateInstanceInAutoScalingGroupType"}, - "output":{ - "shape":"ActivityType", - "resultWrapper":"TerminateInstanceInAutoScalingGroupResult" - }, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group can't be deleted because there are scaling activities in progress.
" - } - ], - "documentation":"Terminates the specified instance and optionally adjusts the desired group size.
The Auto Scaling group can't be deleted because there are scaling activities in progress.
" - } - ], - "documentation":"Updates the configuration for the specified AutoScalingGroup.
To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring flag set to False, you must first ensure that collection of group metrics is disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling DisableMetricsCollection.
The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.
If a new value is specified for MinSize without specifying the value for DesiredCapacity, and if the new MinSize is larger than the current size of the Auto Scaling group, there will be an implicit call to SetDesiredCapacity to set the group to the new MinSize.
If a new value is specified for MaxSize without specifying the value for DesiredCapacity, and the new MaxSize is smaller than the current size of the Auto Scaling group, there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize.
All other optional parameters are left unchanged if not passed in the request.
The scaling activities.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "Activity":{ - "type":"structure", - "required":[ - "ActivityId", - "AutoScalingGroupName", - "Cause", - "StartTime", - "StatusCode" - ], - "members":{ - "ActivityId":{ - "shape":"XmlString", - "documentation":"The ID of the activity.
" - }, - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Auto Scaling group.
" - }, - "Description":{ - "shape":"XmlString", - "documentation":"A friendly, more verbose description of the scaling activity.
" - }, - "Cause":{ - "shape":"XmlStringMaxLen1023", - "documentation":"The reason the activity was begun.
" - }, - "StartTime":{ - "shape":"TimestampType", - "documentation":"The start time of this activity.
" - }, - "EndTime":{ - "shape":"TimestampType", - "documentation":"The end time of this activity.
" - }, - "StatusCode":{ - "shape":"ScalingActivityStatusCode", - "documentation":"The current status of the activity.
" - }, - "StatusMessage":{ - "shape":"XmlStringMaxLen255", - "documentation":"A friendly, more verbose description of the activity status.
" - }, - "Progress":{ - "shape":"Progress", - "documentation":"A value between 0 and 100 that indicates the progress of the activity.
" - }, - "Details":{ - "shape":"XmlString", - "documentation":"The details about the scaling activity.
" - } - }, - "documentation":"Describes a long-running process that represents a change to your Auto Scaling group, such as changing its size. This can also be a process to replace an instance, or a process to perform any other long-running operations.
" - }, - "ActivityIds":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "ActivityType":{ - "type":"structure", - "members":{ - "Activity":{ - "shape":"Activity", - "documentation":"A scaling activity.
" - } - } - }, - "AdjustmentType":{ - "type":"structure", - "members":{ - "AdjustmentType":{ - "shape":"XmlStringMaxLen255", - "documentation":"The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
" - } - }, - "documentation":"Describes a policy adjustment type.
" - }, - "AdjustmentTypes":{ - "type":"list", - "member":{"shape":"AdjustmentType"} - }, - "Alarm":{ - "type":"structure", - "members":{ - "AlarmName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the alarm.
" - }, - "AlarmARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the alarm.
" - } - }, - "documentation":"Describes an alarm.
" - }, - "Alarms":{ - "type":"list", - "member":{"shape":"Alarm"} - }, - "AlreadyExistsFault":{ - "type":"structure", - "members":{ - "message":{"shape":"XmlStringMaxLen255"} - }, - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have an Auto Scaling group or launch configuration with this name.
" - }, - "AsciiStringMaxLen255":{ - "type":"string", - "min":1, - "max":255, - "pattern":"[A-Za-z0-9\\-_\\/]+" - }, - "AssociatePublicIpAddress":{"type":"boolean"}, - "AttachInstancesQuery":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"One or more EC2 instance IDs. You must specify at least one ID.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group.
" - } - } - }, - "AutoScalingGroup":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "LaunchConfigurationName", - "MinSize", - "MaxSize", - "DesiredCapacity", - "DefaultCooldown", - "AvailabilityZones", - "HealthCheckType", - "CreatedTime" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the group.
" - }, - "AutoScalingGroupARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the group.
" - }, - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the associated launch configuration.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"The minimum size of the group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The size of the group.
" - }, - "DefaultCooldown":{ - "shape":"Cooldown", - "documentation":"The number of seconds after a scaling activity completes before any further scaling activities can start.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"One or more Availability Zones for the group.
" - }, - "LoadBalancerNames":{ - "shape":"LoadBalancerNames", - "documentation":"One or more load balancers associated with the group.
" - }, - "HealthCheckType":{ - "shape":"XmlStringMaxLen32", - "documentation":"The service of interest for the health status check, which can be either EC2 for Amazon EC2 or ELB for Elastic Load Balancing.
The amount of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.
" - }, - "Instances":{ - "shape":"Instances", - "documentation":"The EC2 instances associated with the group.
" - }, - "CreatedTime":{ - "shape":"TimestampType", - "documentation":"The date and time the group was created.
" - }, - "SuspendedProcesses":{ - "shape":"SuspendedProcesses", - "documentation":"The suspended processes associated with the group.
" - }, - "PlacementGroup":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups.
" - }, - "VPCZoneIdentifier":{ - "shape":"XmlStringMaxLen255", - "documentation":"One or more subnet IDs, if applicable, separated by commas.
If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.
The metrics enabled for this Auto Scaling group.
" - }, - "Status":{ - "shape":"XmlStringMaxLen255", - "documentation":"The current state of the Auto Scaling group when a DeleteAutoScalingGroup action is in progress.
" - }, - "Tags":{ - "shape":"TagDescriptionList", - "documentation":"The tags for the Auto Scaling group.
" - }, - "TerminationPolicies":{ - "shape":"TerminationPolicies", - "documentation":"The termination policies for this Auto Scaling group.
" - } - }, - "documentation":"Describes an Auto Scaling group.
" - }, - "AutoScalingGroupDesiredCapacity":{"type":"integer"}, - "AutoScalingGroupMaxSize":{"type":"integer"}, - "AutoScalingGroupMinSize":{"type":"integer"}, - "AutoScalingGroupNames":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "AutoScalingGroupNamesType":{ - "type":"structure", - "members":{ - "AutoScalingGroupNames":{ - "shape":"AutoScalingGroupNames", - "documentation":"The group names.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call.
" - } - } - }, - "AutoScalingGroups":{ - "type":"list", - "member":{"shape":"AutoScalingGroup"} - }, - "AutoScalingGroupsType":{ - "type":"structure", - "required":["AutoScalingGroups"], - "members":{ - "AutoScalingGroups":{ - "shape":"AutoScalingGroups", - "documentation":"The groups.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "AutoScalingInstanceDetails":{ - "type":"structure", - "required":[ - "InstanceId", - "AutoScalingGroupName", - "AvailabilityZone", - "LifecycleState", - "HealthStatus", - "LaunchConfigurationName" - ], - "members":{ - "InstanceId":{ - "shape":"XmlStringMaxLen16", - "documentation":"The ID of the instance.
" - }, - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Auto Scaling group associated with the instance.
" - }, - "AvailabilityZone":{ - "shape":"XmlStringMaxLen255", - "documentation":"The Availability Zone for the instance.
" - }, - "LifecycleState":{ - "shape":"XmlStringMaxLen32", - "documentation":"The lifecycle state for the instance. For more information, see Auto Scaling Instance States in the Auto Scaling Developer Guide.
" - }, - "HealthStatus":{ - "shape":"XmlStringMaxLen32", - "documentation":"The health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Auto Scaling should terminate and replace it.
" - }, - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The launch configuration associated with the instance.
" - } - }, - "documentation":"Describes an EC2 instance associated with an Auto Scaling group.
" - }, - "AutoScalingInstances":{ - "type":"list", - "member":{"shape":"AutoScalingInstanceDetails"} - }, - "AutoScalingInstancesType":{ - "type":"structure", - "members":{ - "AutoScalingInstances":{ - "shape":"AutoScalingInstances", - "documentation":"The instances.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "AutoScalingNotificationTypes":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "AvailabilityZones":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"}, - "min":1 - }, - "BlockDeviceEbsDeleteOnTermination":{"type":"boolean"}, - "BlockDeviceEbsIops":{ - "type":"integer", - "min":100, - "max":30000 - }, - "BlockDeviceEbsVolumeSize":{ - "type":"integer", - "min":1, - "max":16384 - }, - "BlockDeviceEbsVolumeType":{ - "type":"string", - "min":1, - "max":255 - }, - "BlockDeviceMapping":{ - "type":"structure", - "required":["DeviceName"], - "members":{ - "VirtualName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the virtual device, ephemeral0 to ephemeral3.
The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).
The information about the Amazon EBS volume.
" - }, - "NoDevice":{ - "shape":"NoDevice", - "documentation":"Suppresses a device mapping.
NoDevice is set to true for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.Describes a block device mapping.
" - }, - "BlockDeviceMappings":{ - "type":"list", - "member":{"shape":"BlockDeviceMapping"} - }, - "ClassicLinkVPCSecurityGroups":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "CompleteLifecycleActionAnswer":{ - "type":"structure", - "members":{ - } - }, - "CompleteLifecycleActionType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName", - "LifecycleActionToken", - "LifecycleActionResult" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group for the lifecycle hook.
" - }, - "LifecycleActionToken":{ - "shape":"LifecycleActionToken", - "documentation":"A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
" - }, - "LifecycleActionResult":{ - "shape":"LifecycleActionResult", - "documentation":"The action for the group to take. This parameter can be either CONTINUE or ABANDON.
The name of the group. This name must be unique within the scope of your AWS account.
" - }, - "LaunchConfigurationName":{ - "shape":"ResourceName", - "documentation":"The name of the launch configuration. Alternatively, use the InstanceId parameter to specify an EC2 instance instead of a launch configuration.
The ID of the EC2 instance used to create a launch configuration for the group. Alternatively, use the LaunchConfigurationName parameter to specify a launch configuration instead of an EC2 instance.
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.
For more information, see Create an Auto Scaling Group Using an EC2 Instance ID in the Auto Scaling Developer Guide.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"The minimum size of the group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of EC2 instances that should be running in the group. This value must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
" - }, - "DefaultCooldown":{ - "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
If DefaultCooldown is not specified, the default value is 300. For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
One or more Availability Zones for the group. This parameter is optional if you specify subnets using the VPCZoneIdentifier parameter.
One or more load balancers.
For more information, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "HealthCheckType":{ - "shape":"XmlStringMaxLen32", - "documentation":"The service to use for the health checks. The valid values are EC2 and ELB.
By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks.
" - }, - "HealthCheckGracePeriod":{ - "shape":"HealthCheckGracePeriod", - "documentation":"The amount of time, in seconds, after an EC2 instance comes into service that Auto Scaling starts checking its health. During this time, any health check failures for the instance are ignored.
This parameter is required if you are adding an ELB health check. Frequently, new instances need to warm up, briefly, before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to match the expected startup period of your application.
For more information, see Add an Elastic Load Balancing Health Check to Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "PlacementGroup":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups.
" - }, - "VPCZoneIdentifier":{ - "shape":"XmlStringMaxLen255", - "documentation":"A comma-separated list of subnet identifiers for your virtual private cloud (VPC).
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For more information, see Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
" - }, - "TerminationPolicies":{ - "shape":"TerminationPolicies", - "documentation":"One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "Tags":{ - "shape":"Tags", - "documentation":"The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.
For more information, see Add, Modify, or Remove Auto Scaling Group Tags in the Auto Scaling Developer Guide.
" - } - } - }, - "CreateLaunchConfigurationType":{ - "type":"structure", - "required":["LaunchConfigurationName"], - "members":{ - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the launch configuration. This name must be unique within the scope of your AWS account.
" - }, - "ImageId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.
" - }, - "KeyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"One or more security groups with which to associate the instances.
If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched in a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "ClassicLinkVPCId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
" - }, - "ClassicLinkVPCSecurityGroups":{ - "shape":"ClassicLinkVPCSecurityGroups", - "documentation":"The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if ClassicLinkVPCId is specified, and cannot be used otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.
The ID of the EC2 instance to use to create the launch configuration.
The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling Developer Guide.
" - }, - "InstanceType":{ - "shape":"XmlStringMaxLen255", - "documentation":"The instance type of the Amazon EC2 instance. For information about available Amazon EC2 instance types, see Available Instance Types in the Amazon Elastic Cloud Compute User Guide.
" - }, - "KernelId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the kernel associated with the Amazon EC2 AMI.
" - }, - "RamdiskId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the RAM disk associated with the Amazon EC2 AMI.
" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappings", - "documentation":"One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon Elastic Compute Cloud User Guide.
" - }, - "InstanceMonitoring":{ - "shape":"InstanceMonitoring", - "documentation":"Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.
When detailed monitoring is enabled, Amazon Cloudwatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, by specifying False, Cloudwatch generates metrics every 5 minutes. For more information, see Monitor Your Auto Scaling Instances in the Auto Scaling Developer Guide.
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 Launch Spot Instances in Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "IamInstanceProfile":{ - "shape":"XmlStringMaxLen1600", - "documentation":"The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling Developer Guide.
" - }, - "EbsOptimized":{ - "shape":"EbsOptimized", - "documentation":"Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "AssociatePublicIpAddress":{ - "shape":"AssociatePublicIpAddress", - "documentation":"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 Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
If you specify a value for this parameter, be sure to specify at least one subnet using the VPCZoneIdentifier parameter when you create your group.
Default: If the instance is launched into a default subnet, the default is true. If the instance is launched into a nondefault subnet, the default is false. For more information, see Supported Platforms in the Amazon Elastic Compute Cloud User Guide.
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched in a VPC.
You must set the value of this parameter to dedicated if want to launch Dedicated Instances in a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your group.
For more information, see Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
Valid values: default | dedicated
The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. The resource type and resource ID identify the type and name of resource for which the tag is created. Currently, auto-scaling-group is the only supported resource type. The valid value for the resource ID is groupname.
The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by the group. Valid values are true or false. However, instances that are already running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be applied only to new instances launched by the group after the change. Running instances that had the previous version of the tag will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
" - } - } - }, - "DeleteAutoScalingGroupType":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group to delete.
" - }, - "ForceDelete":{ - "shape":"ForceDelete", - "documentation":"Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
" - } - } - }, - "DeleteLifecycleHookAnswer":{ - "type":"structure", - "members":{ - } - }, - "DeleteLifecycleHookType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group for the lifecycle hook.
" - } - } - }, - "DeleteNotificationConfigurationType":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "TopicARN" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "TopicARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
" - } - } - }, - "DeletePolicyType":{ - "type":"structure", - "required":["PolicyName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "PolicyName":{ - "shape":"ResourceName", - "documentation":"The name or Amazon Resource Name (ARN) of the policy.
" - } - }, - "documentation":"" - }, - "DeleteScheduledActionType":{ - "type":"structure", - "required":["ScheduledActionName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "ScheduledActionName":{ - "shape":"ResourceName", - "documentation":"The name of the action to delete.
" - } - } - }, - "DeleteTagsType":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"Tags", - "documentation":"Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, key=value, value=value, propagate=true or false.
" - } - } - }, - "DescribeAccountLimitsAnswer":{ - "type":"structure", - "members":{ - "MaxNumberOfAutoScalingGroups":{ - "shape":"MaxNumberOfAutoScalingGroups", - "documentation":"The maximum number of groups allowed for your AWS account. The default limit is 20 per region.
" - }, - "MaxNumberOfLaunchConfigurations":{ - "shape":"MaxNumberOfLaunchConfigurations", - "documentation":"The maximum number of launch configurations allowed for your AWS account. The default limit is 100 per region.
" - } - } - }, - "DescribeAdjustmentTypesAnswer":{ - "type":"structure", - "members":{ - "AdjustmentTypes":{ - "shape":"AdjustmentTypes", - "documentation":"The policy adjustment types.
" - } - } - }, - "DescribeAutoScalingInstancesType":{ - "type":"structure", - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - } - } - }, - "DescribeAutoScalingNotificationTypesAnswer":{ - "type":"structure", - "members":{ - "AutoScalingNotificationTypes":{ - "shape":"AutoScalingNotificationTypes", - "documentation":"One or more of the following notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
One or more of the following notification types:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
The lifecycle hooks for the specified group.
" - } - } - }, - "DescribeLifecycleHooksType":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group.
" - }, - "LifecycleHookNames":{ - "shape":"LifecycleHookNames", - "documentation":"The names of one or more lifecycle hooks.
" - } - } - }, - "DescribeMetricCollectionTypesAnswer":{ - "type":"structure", - "members":{ - "Metrics":{ - "shape":"MetricCollectionTypes", - "documentation":"One or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
The granularities for the listed metrics.
" - } - } - }, - "DescribeNotificationConfigurationsAnswer":{ - "type":"structure", - "required":["NotificationConfigurations"], - "members":{ - "NotificationConfigurations":{ - "shape":"NotificationConfigurations", - "documentation":"The notification configurations.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "DescribeNotificationConfigurationsType":{ - "type":"structure", - "members":{ - "AutoScalingGroupNames":{ - "shape":"AutoScalingGroupNames", - "documentation":"The name of the group.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call.
" - } - } - }, - "DescribePoliciesType":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group.
" - }, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to be returned with each call.
" - } - } - }, - "DescribeScalingActivitiesType":{ - "type":"structure", - "members":{ - "ActivityIds":{ - "shape":"ActivityIds", - "documentation":" A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.
The name of the group.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - } - } - }, - "DescribeScheduledActionsType":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group.
" - }, - "ScheduledActionNames":{ - "shape":"ScheduledActionNames", - "documentation":"Describes one or more scheduled actions. If you omit this list, the call describes all scheduled actions. If you specify an unknown scheduled action it is ignored with no error.
You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.
The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
" - }, - "EndTime":{ - "shape":"TimestampType", - "documentation":"The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call.
" - } - } - }, - "DescribeTagsType":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"Filters", - "documentation":"The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call.
" - } - } - }, - "DescribeTerminationPolicyTypesAnswer":{ - "type":"structure", - "members":{ - "TerminationPolicyTypes":{ - "shape":"TerminationPolicies", - "documentation":"The Termination policies supported by Auto Scaling. They are: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, and Default.
The activities related to detaching the instances from the Auto Scaling group.
" - } - } - }, - "DetachInstancesQuery":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "ShouldDecrementDesiredCapacity" - ], - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"One or more instance IDs.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group.
" - }, - "ShouldDecrementDesiredCapacity":{ - "shape":"ShouldDecrementDesiredCapacity", - "documentation":"If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
The name or Amazon Resource Name (ARN) of the group.
" - }, - "Metrics":{ - "shape":"Metrics", - "documentation":"One or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
If you omit this parameter, all metrics are disabled.
" - } - } - }, - "Ebs":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the snapshot.
" - }, - "VolumeSize":{ - "shape":"BlockDeviceEbsVolumeSize", - "documentation":"The volume size, in gigabytes.
Valid values: If the volume type is io1, the minimum size of the volume is 10 GiB. If you specify SnapshotId and VolumeSize, VolumeSize must be equal to or larger than the size of the snapshot.
Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the size of the snapshot.
Required: Required when the volume type is io1.
The volume type.
Valid values: standard | io1 | gp2
Default: standard
Indicates whether to delete the volume on instance termination.
Default: true
For Provisioned IOPS (SSD) volumes only. The number of I/O operations per second (IOPS) to provision for the volume.
Valid values: Range is 100 to 4000.
Default: None
" - } - }, - "documentation":"Describes an Amazon EBS volume.
" - }, - "EbsOptimized":{"type":"boolean"}, - "EnableMetricsCollectionQuery":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "Granularity" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name or ARN of the Auto Scaling group.
" - }, - "Metrics":{ - "shape":"Metrics", - "documentation":"One or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
If you omit this parameter, all metrics are enabled.
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
The granularity to associate with the metrics to collect. Currently, the only valid value is \"1Minute\".
" - } - } - }, - "EnabledMetric":{ - "type":"structure", - "members":{ - "Metric":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the metric.
" - }, - "Granularity":{ - "shape":"XmlStringMaxLen255", - "documentation":"The granularity of the metric.
" - } - }, - "documentation":"Describes an enabled metric.
" - }, - "EnabledMetrics":{ - "type":"list", - "member":{"shape":"EnabledMetric"} - }, - "EnterStandbyAnswer":{ - "type":"structure", - "members":{ - "Activities":{ - "shape":"Activities", - "documentation":"The activities related to moving instances into Standby mode.
One or more instances to move into Standby mode. You must specify at least one instance ID.
The name of the Auto Scaling group.
" - }, - "ShouldDecrementDesiredCapacity":{ - "shape":"ShouldDecrementDesiredCapacity", - "documentation":"Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
" - }, - "PolicyName":{ - "shape":"ResourceName", - "documentation":"The name or ARN of the policy.
" - }, - "HonorCooldown":{ - "shape":"HonorCooldown", - "documentation":"Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
" - } - } - }, - "ExitStandbyAnswer":{ - "type":"structure", - "members":{ - "Activities":{ - "shape":"Activities", - "documentation":"The activities related to moving instances out of Standby mode.
One or more instance IDs. You must specify at least one instance ID.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - } - } - }, - "Filter":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"XmlString", - "documentation":"The name of the filter. The valid values are: \"auto-scaling-group\", \"key\", \"value\", and \"propagate-at-launch\".
The value of the filter.
" - } - }, - "documentation":"Describes a filter.
" - }, - "Filters":{ - "type":"list", - "member":{"shape":"Filter"} - }, - "ForceDelete":{"type":"boolean"}, - "GlobalTimeout":{"type":"integer"}, - "HealthCheckGracePeriod":{"type":"integer"}, - "HeartbeatTimeout":{"type":"integer"}, - "HonorCooldown":{"type":"boolean"}, - "Instance":{ - "type":"structure", - "required":[ - "InstanceId", - "AvailabilityZone", - "LifecycleState", - "HealthStatus", - "LaunchConfigurationName" - ], - "members":{ - "InstanceId":{ - "shape":"XmlStringMaxLen16", - "documentation":"The ID of the instance.
" - }, - "AvailabilityZone":{ - "shape":"XmlStringMaxLen255", - "documentation":"The Availability Zone associated with this instance.
" - }, - "LifecycleState":{ - "shape":"LifecycleState", - "documentation":"A description of the current lifecycle state.
The Quarantined lifecycle state is not used.
The health status of the instance.
" - }, - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The launch configuration associated with the instance.
" - } - }, - "documentation":"Describes an EC2 instance.
" - }, - "InstanceIds":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen16"} - }, - "InstanceMonitoring":{ - "type":"structure", - "members":{ - "Enabled":{ - "shape":"MonitoringEnabled", - "documentation":"If True, instance monitoring is enabled.
Describes whether instance monitoring is enabled.
" - }, - "Instances":{ - "type":"list", - "member":{"shape":"Instance"} - }, - "InvalidNextToken":{ - "type":"structure", - "members":{ - "message":{"shape":"XmlStringMaxLen255"} - }, - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The NextToken value is not valid.
The name of the launch configuration.
" - }, - "LaunchConfigurationARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the launch configuration.
" - }, - "ImageId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the Amazon Machine Image (AMI).
" - }, - "KeyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the key pair.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"The security groups to associate with the EC2 instances.
" - }, - "ClassicLinkVPCId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
" - }, - "ClassicLinkVPCSecurityGroups":{ - "shape":"ClassicLinkVPCSecurityGroups", - "documentation":"The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if ClassicLinkVPCId is specified, and cannot be used otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
The user data available to the EC2 instances.
" - }, - "InstanceType":{ - "shape":"XmlStringMaxLen255", - "documentation":"The instance type for the EC2 instances.
" - }, - "KernelId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the kernel associated with the AMI.
" - }, - "RamdiskId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the RAM disk associated with the AMI.
" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappings", - "documentation":"A block device mapping that specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.
Controls whether instances in this group are launched with detailed monitoring.
" - }, - "SpotPrice":{ - "shape":"SpotPrice", - "documentation":"The price to bid when launching Spot Instances.
" - }, - "IamInstanceProfile":{ - "shape":"XmlStringMaxLen1600", - "documentation":"The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
" - }, - "CreatedTime":{ - "shape":"TimestampType", - "documentation":"The creation date and time for the launch configuration.
" - }, - "EbsOptimized":{ - "shape":"EbsOptimized", - "documentation":"Controls whether the instance is optimized for EBS I/O (true) or not (false).
Specifies whether the EC2 instances are associated with a public IP address (true) or not (false).
The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched in a VPC.
Describes a launch configuration.
" - }, - "LaunchConfigurationNameType":{ - "type":"structure", - "required":["LaunchConfigurationName"], - "members":{ - "LaunchConfigurationName":{ - "shape":"ResourceName", - "documentation":"The name of the launch configuration.
" - } - } - }, - "LaunchConfigurationNames":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "LaunchConfigurationNamesType":{ - "type":"structure", - "members":{ - "LaunchConfigurationNames":{ - "shape":"LaunchConfigurationNames", - "documentation":"The launch configuration names.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of items to return with this call. The default is 100.
" - } - } - }, - "LaunchConfigurations":{ - "type":"list", - "member":{"shape":"LaunchConfiguration"} - }, - "LaunchConfigurationsType":{ - "type":"structure", - "required":["LaunchConfigurations"], - "members":{ - "LaunchConfigurations":{ - "shape":"LaunchConfigurations", - "documentation":"The launch configurations.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "LifecycleActionResult":{"type":"string"}, - "LifecycleActionToken":{ - "type":"string", - "min":36, - "max":36 - }, - "LifecycleHook":{ - "type":"structure", - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group for the lifecycle hook.
" - }, - "LifecycleTransition":{ - "shape":"LifecycleTransition", - "documentation":"The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHooks.
" - }, - "NotificationTargetARN":{ - "shape":"ResourceName", - "documentation":"The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
" - }, - "NotificationMetadata":{ - "shape":"XmlStringMaxLen1023", - "documentation":"Additional information that you want to include any time Auto Scaling sends a message to the notification target.
" - }, - "HeartbeatTimeout":{ - "shape":"HeartbeatTimeout", - "documentation":"The amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
The maximum length of time an instance can remain in a Pending:Wait or Terminating:Wait state. Currently, this value is set at 48 hours.
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 CONTINUE and ABANDON. The default value is CONTINUE.
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:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.
" - }, - "LifecycleHookNames":{ - "type":"list", - "member":{"shape":"AsciiStringMaxLen255"} - }, - "LifecycleHooks":{ - "type":"list", - "member":{"shape":"LifecycleHook"} - }, - "LifecycleState":{ - "type":"string", - "enum":[ - "Pending", - "Pending:Wait", - "Pending:Proceed", - "Quarantined", - "InService", - "Terminating", - "Terminating:Wait", - "Terminating:Proceed", - "Terminated", - "Detaching", - "Detached", - "EnteringStandby", - "Standby" - ] - }, - "LifecycleTransition":{"type":"string"}, - "LimitExceededFault":{ - "type":"structure", - "members":{ - "message":{"shape":"XmlStringMaxLen255"} - }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The limit for the number of Auto Scaling groups or launch configurations has already been reached.
" - }, - "LoadBalancerNames":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "MaxNumberOfAutoScalingGroups":{"type":"integer"}, - "MaxNumberOfLaunchConfigurations":{"type":"integer"}, - "MaxRecords":{"type":"integer"}, - "MetricCollectionType":{ - "type":"structure", - "members":{ - "Metric":{ - "shape":"XmlStringMaxLen255", - "documentation":"The metric.
" - } - }, - "documentation":"Describes a metric.
" - }, - "MetricCollectionTypes":{ - "type":"list", - "member":{"shape":"MetricCollectionType"} - }, - "MetricGranularityType":{ - "type":"structure", - "members":{ - "Granularity":{ - "shape":"XmlStringMaxLen255", - "documentation":"The granularity.
" - } - }, - "documentation":"Describes a granularity of a metric.
" - }, - "MetricGranularityTypes":{ - "type":"list", - "member":{"shape":"MetricGranularityType"} - }, - "Metrics":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "MinAdjustmentStep":{"type":"integer"}, - "MonitoringEnabled":{"type":"boolean"}, - "NoDevice":{"type":"boolean"}, - "NotificationConfiguration":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the group.
" - }, - "TopicARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
" - }, - "NotificationType":{ - "shape":"XmlStringMaxLen255", - "documentation":"The types of events for an action to start.
" - } - }, - "documentation":"Describes a notification.
" - }, - "NotificationConfigurations":{ - "type":"list", - "member":{"shape":"NotificationConfiguration"} - }, - "PoliciesType":{ - "type":"structure", - "members":{ - "ScalingPolicies":{ - "shape":"ScalingPolicies", - "documentation":"The scaling policies.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "PolicyARNType":{ - "type":"structure", - "members":{ - "PolicyARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the policy.
" - } - } - }, - "PolicyIncrement":{"type":"integer"}, - "PolicyNames":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "ProcessNames":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "ProcessType":{ - "type":"structure", - "required":["ProcessName"], - "members":{ - "ProcessName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the process.
" - } - }, - "documentation":"Describes a process type.
There are two primary Auto Scaling process types--Launch and Terminate. The Launch process creates a new EC2 instance for an Auto Scaling group, and the Terminate process removes an existing EC2 instance. The remaining Auto Scaling process types relate to specific Auto Scaling features:
Launch or Terminate, all other process types are affected to varying degrees. The following descriptions discuss how each process type is affected by a suspension of Launch or Terminate. The AddToLoadBalancer process type adds instances to the load balancer when the instances are launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to the load balancer. If you resume the AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load balancer when they are launched. However, Auto Scaling will not add running instances that were launched while the process was suspended; those instances must be added manually using the RegisterInstancesWithLoadBalancer call.
The AlarmNotification process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the AlarmNotification process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms.
Although the AlarmNotification process type is not directly affected by a suspension of Launch or Terminate, alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend Launch or Terminate, Auto Scaling might not be able to implement the alarm's associated policy.
The AZRebalance process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated Availability Zones.
If you call SuspendProcesses on the launch process type, the AZRebalance process will neither launch new instances nor terminate existing instances. This is because the AZRebalance process terminates existing instances only after launching the replacement instances.
If you call SuspendProcesses on the terminate process type, the AZRebalance process can cause your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could remain up to ten percent larger than the maximum size until you resume the terminate process type.
The HealthCheck process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy. The HealthCheck process can override the health status of an instance that you set with SetInstanceHealth.
The ReplaceUnhealthy process type terminates instances that are marked as unhealthy and subsequently creates new instances to replace them. This process calls both of the primary process types--first Terminate and then Launch.
The HealthCheck process type works in conjunction with the ReplaceUnhealthly process type to provide health check functionality. If you suspend either Launch or Terminate, the ReplaceUnhealthy process type will not function properly.
The ScheduledActions process type performs scheduled actions that you create with PutScheduledUpdateGroupAction. Scheduled actions often involve launching new instances or terminating existing instances. If you suspend either Launch or Terminate, your scheduled actions might not function as expected.
The names of the process types.
" - } - } - }, - "Progress":{"type":"integer"}, - "PropagateAtLaunch":{"type":"boolean"}, - "PutLifecycleHookAnswer":{ - "type":"structure", - "members":{ - } - }, - "PutLifecycleHookType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which you want to assign the lifecycle hook.
" - }, - "LifecycleTransition":{ - "shape":"LifecycleTransition", - "documentation":"The Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHookTypes for a list of available lifecycle hook types.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The notification message sent to the target will include:
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
" - }, - "HeartbeatTimeout":{ - "shape":"HeartbeatTimeout", - "documentation":"Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.
The name of the Auto Scaling group.
" - }, - "TopicARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
" - }, - "NotificationTypes":{ - "shape":"AutoScalingNotificationTypes", - "documentation":"The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
" - } - } - }, - "PutScalingPolicyType":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "PolicyName", - "ScalingAdjustment", - "AdjustmentType" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name or ARN of the group.
" - }, - "PolicyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the policy.
" - }, - "ScalingAdjustment":{ - "shape":"PolicyIncrement", - "documentation":"The number of instances by which to scale. AdjustmentType determines the interpretation of this number (e.g., as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.
Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
" - }, - "Cooldown":{ - "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
" - }, - "MinAdjustmentStep":{ - "shape":"MinAdjustmentStep", - "documentation":"Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.
You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
" - }, - "ScheduledActionName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of this scaling action.
" - }, - "Time":{ - "shape":"TimestampType", - "documentation":"Time is deprecated.
The time for this action to start. Time is an alias for StartTime and can be specified instead of StartTime, or vice versa. If both Time and StartTime are specified, their values should be identical. Otherwise, PutScheduledUpdateGroupAction will return an error.
The time for this action to start, as in --start-time 2010-06-01T00:00:00Z.
If you try to schedule your action in the past, Auto Scaling returns an error message.
When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.
The time for this action to end.
" - }, - "Recurrence":{ - "shape":"XmlStringMaxLen255", - "documentation":"The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information about cron syntax, go to Wikipedia, The Free Encyclopedia.
When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.
The minimum size for the new Auto Scaling group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size for the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of Amazon EC2 instances that should be running in the group.
" - } - } - }, - "RecordLifecycleActionHeartbeatAnswer":{ - "type":"structure", - "members":{ - } - }, - "RecordLifecycleActionHeartbeatType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName", - "LifecycleActionToken" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group for the hook.
" - }, - "LifecycleActionToken":{ - "shape":"LifecycleActionToken", - "documentation":"A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
" - } - } - }, - "ResourceInUseFault":{ - "type":"structure", - "members":{ - "message":{"shape":"XmlStringMaxLen255"} - }, - "error":{ - "code":"ResourceInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group or launch configuration can't be deleted because it is in use.
" - }, - "ResourceName":{ - "type":"string", - "min":1, - "max":1600, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "ScalingActivityInProgressFault":{ - "type":"structure", - "members":{ - "message":{"shape":"XmlStringMaxLen255"} - }, - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Auto Scaling group can't be deleted because there are scaling activities in progress.
" - }, - "ScalingActivityStatusCode":{ - "type":"string", - "enum":[ - "WaitingForSpotInstanceRequestId", - "WaitingForSpotInstanceId", - "WaitingForInstanceId", - "PreInService", - "InProgress", - "WaitingForELBConnectionDraining", - "MidLifecycleAction", - "Successful", - "Failed", - "Cancelled" - ] - }, - "ScalingPolicies":{ - "type":"list", - "member":{"shape":"ScalingPolicy"} - }, - "ScalingPolicy":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Auto Scaling group associated with this scaling policy.
" - }, - "PolicyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the scaling policy.
" - }, - "ScalingAdjustment":{ - "shape":"PolicyIncrement", - "documentation":"The number associated with the specified adjustment type. A positive value adds to the current capacity and a negative value removes from the current capacity.
" - }, - "AdjustmentType":{ - "shape":"XmlStringMaxLen255", - "documentation":"Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
" - }, - "PolicyARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the policy.
" - }, - "Alarms":{ - "shape":"Alarms", - "documentation":"The CloudWatch Alarms related to the policy.
" - }, - "MinAdjustmentStep":{ - "shape":"MinAdjustmentStep", - "documentation":"Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.
Describes a scaling policy.
" - }, - "ScalingProcessQuery":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name or Amazon Resource Name (ARN) of the Auto Scaling group.
" - }, - "ScalingProcesses":{ - "shape":"ProcessNames", - "documentation":"One or more of the following processes:
The scheduled actions.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "ScheduledUpdateGroupAction":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the group.
" - }, - "ScheduledActionName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the scheduled action.
" - }, - "ScheduledActionARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the scheduled action.
" - }, - "Time":{ - "shape":"TimestampType", - "documentation":"Time is deprecated.
The time that the action is scheduled to begin. Time is an alias for StartTime.
The time that the action is scheduled to begin. This value can be up to one month in the future.
When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.
The time that the action is scheduled to end. This value can be up to one month in the future.
" - }, - "Recurrence":{ - "shape":"XmlStringMaxLen255", - "documentation":"The regular schedule that an action occurs.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"The minimum size of the group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of instances you prefer to maintain in the group.
" - } - }, - "documentation":"Describes a scheduled update to an Auto Scaling group.
" - }, - "ScheduledUpdateGroupActions":{ - "type":"list", - "member":{"shape":"ScheduledUpdateGroupAction"} - }, - "SecurityGroups":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "SetDesiredCapacityType":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "DesiredCapacity" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of EC2 instances that should be running in the Auto Scaling group.
" - }, - "HonorCooldown":{ - "shape":"HonorCooldown", - "documentation":"By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.
The ID of the EC2 instance.
" - }, - "HealthStatus":{ - "shape":"XmlStringMaxLen32", - "documentation":" The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.
For more information, see the HealthCheckGracePeriod parameter description for CreateAutoScalingGroup.
The name of the suspended process.
" - }, - "SuspensionReason":{ - "shape":"XmlStringMaxLen255", - "documentation":"The reason that the process was suspended.
" - } - }, - "documentation":"Describes an Auto Scaling process that has been suspended. For more information, see ProcessType.
" - }, - "SuspendedProcesses":{ - "type":"list", - "member":{"shape":"SuspendedProcess"} - }, - "Tag":{ - "type":"structure", - "required":["Key"], - "members":{ - "ResourceId":{ - "shape":"XmlString", - "documentation":"The name of the group.
" - }, - "ResourceType":{ - "shape":"XmlString", - "documentation":"The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.
The tag key.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The tag value.
" - }, - "PropagateAtLaunch":{ - "shape":"PropagateAtLaunch", - "documentation":"Specifies whether the tag is applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, it is applied to all instances launched after you made the change.
" - } - }, - "documentation":"Describes a tag applied to an Auto Scaling group.
" - }, - "TagDescription":{ - "type":"structure", - "members":{ - "ResourceId":{ - "shape":"XmlString", - "documentation":"The name of the group.
" - }, - "ResourceType":{ - "shape":"XmlString", - "documentation":"The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.
The tag key.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The tag value.
" - }, - "PropagateAtLaunch":{ - "shape":"PropagateAtLaunch", - "documentation":"Specifies whether the tag is applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, it is applied to all instances launched after you made the change.
" - } - }, - "documentation":"Describes a tag applied to an Auto Scaling group.
" - }, - "TagDescriptionList":{ - "type":"list", - "member":{"shape":"TagDescription"} - }, - "TagKey":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "TagValue":{ - "type":"string", - "min":0, - "max":256, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "Tags":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "TagsType":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagDescriptionList", - "documentation":"The tags.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" - } - } - }, - "TerminateInstanceInAutoScalingGroupType":{ - "type":"structure", - "required":[ - "InstanceId", - "ShouldDecrementDesiredCapacity" - ], - "members":{ - "InstanceId":{ - "shape":"XmlStringMaxLen16", - "documentation":"The ID of the EC2 instance.
" - }, - "ShouldDecrementDesiredCapacity":{ - "shape":"ShouldDecrementDesiredCapacity", - "documentation":"If true, terminating this instance also decrements the size of the Auto Scaling group.
The name of the Auto Scaling group.
" - }, - "LaunchConfigurationName":{ - "shape":"ResourceName", - "documentation":"The name of the launch configuration.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"The minimum size of the Auto Scaling group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of EC2 instances that should be running in the Auto Scaling group. This value must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
" - }, - "DefaultCooldown":{ - "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. For more information, see Understanding Auto Scaling Cooldowns.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"One or more Availability Zones for the group.
" - }, - "HealthCheckType":{ - "shape":"XmlStringMaxLen32", - "documentation":" The type of health check for the instances in the Auto Scaling group. The health check type can either be EC2 for Amazon EC2 or ELB for Elastic Load Balancing.
The amount of time, in second, that Auto Scaling waits before checking the health status of an instance. The grace period begins when the instance passes System Status and the Instance Status checks from Amazon EC2. For more information, see DescribeInstanceStatus.
" - }, - "PlacementGroup":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups.
" - }, - "VPCZoneIdentifier":{ - "shape":"XmlStringMaxLen255", - "documentation":"The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.
When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.
For more information, see Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
" - }, - "TerminationPolicies":{ - "shape":"TerminationPolicies", - "documentation":"A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - } - } - }, - "Values":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "XmlString":{ - "type":"string", - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen1023":{ - "type":"string", - "min":1, - "max":1023, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen16":{ - "type":"string", - "min":1, - "max":16, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen1600":{ - "type":"string", - "min":1, - "max":1600, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen255":{ - "type":"string", - "min":1, - "max":255, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen32":{ - "type":"string", - "min":1, - "max":32, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen64":{ - "type":"string", - "min":1, - "max":64, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringUserData":{ - "type":"string", - "max":21847, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/autoscaling/2011-01-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/autoscaling/2011-01-01.paginators.json deleted file mode 100644 index 31bc094456..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/autoscaling/2011-01-01.paginators.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "pagination": { - "DescribeAutoScalingGroups": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "AutoScalingGroups" - }, - "DescribeAutoScalingInstances": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "AutoScalingInstances" - }, - "DescribeLaunchConfigurations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "LaunchConfigurations" - }, - "DescribeNotificationConfigurations": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "NotificationConfigurations" - }, - "DescribePolicies": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "ScalingPolicies" - }, - "DescribeScalingActivities": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "Activities" - }, - "DescribeScheduledActions": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "ScheduledUpdateGroupActions" - }, - "DescribeTags": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "Tags" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudformation/2010-05-15.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudformation/2010-05-15.normal.json deleted file mode 100644 index c893b60473..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudformation/2010-05-15.normal.json +++ /dev/null @@ -1,1457 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-05-15", - "endpointPrefix":"cloudformation", - "serviceFullName":"AWS CloudFormation", - "signatureVersion":"v4", - "xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/", - "protocol":"query" - }, - "documentation":"AWS CloudFormation 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.
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.
For more information about this product, go to the CloudFormation Product Page.
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 http://aws.amazon.com/documentation/.
", - "operations":{ - "CancelUpdateStack":{ - "name":"CancelUpdateStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CancelUpdateStackInput", - "documentation":"The input for CancelUpdateStack action.
" - }, - "documentation":"Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.
The input for CreateStack action.
" - }, - "output":{ - "shape":"CreateStackOutput", - "documentation":"The output for a CreateStack action.
", - "resultWrapper":"CreateStackResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceededException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Quota for the resource has already been reached.
" - }, - { - "shape":"AlreadyExistsException", - "error":{ - "code":"AlreadyExistsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Resource with the name requested already exists.
" - }, - { - "shape":"InsufficientCapabilitiesException", - "error":{ - "code":"InsufficientCapabilitiesException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The template contains resources with capabilities that were not specified in the Capabilities parameter.
" - } - ], - "documentation":"Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
" - }, - "DeleteStack":{ - "name":"DeleteStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteStackInput", - "documentation":"The input for DeleteStack action.
" - }, - "documentation":"Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
" - }, - "DescribeStackEvents":{ - "name":"DescribeStackEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeStackEventsInput", - "documentation":"The input for DescribeStackEvents action.
" - }, - "output":{ - "shape":"DescribeStackEventsOutput", - "documentation":"The output for a DescribeStackEvents action.
", - "resultWrapper":"DescribeStackEventsResult" - }, - "documentation":"Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.
The input for DescribeStackResource action.
" - }, - "output":{ - "shape":"DescribeStackResourceOutput", - "documentation":"The output for a DescribeStackResource action.
", - "resultWrapper":"DescribeStackResourceResult" - }, - "documentation":"Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
" - }, - "DescribeStackResources":{ - "name":"DescribeStackResources", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeStackResourcesInput", - "documentation":"The input for DescribeStackResources action.
" - }, - "output":{ - "shape":"DescribeStackResourcesOutput", - "documentation":"The output for a DescribeStackResources action.
", - "resultWrapper":"DescribeStackResourcesResult" - }, - "documentation":"Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
ListStackResources instead.For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.The input for DescribeStacks action.
" - }, - "output":{ - "shape":"DescribeStacksOutput", - "documentation":"The output for a DescribeStacks action.
", - "resultWrapper":"DescribeStacksResult" - }, - "documentation":"Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
" - }, - "EstimateTemplateCost":{ - "name":"EstimateTemplateCost", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EstimateTemplateCostInput"}, - "output":{ - "shape":"EstimateTemplateCostOutput", - "documentation":"The output for a EstimateTemplateCost action.
", - "resultWrapper":"EstimateTemplateCostResult" - }, - "documentation":"Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
" - }, - "GetStackPolicy":{ - "name":"GetStackPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetStackPolicyInput", - "documentation":"The input for the GetStackPolicy action.
" - }, - "output":{ - "shape":"GetStackPolicyOutput", - "documentation":"The output for the GetStackPolicy action.
", - "resultWrapper":"GetStackPolicyResult" - }, - "documentation":"Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
" - }, - "GetTemplate":{ - "name":"GetTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetTemplateInput", - "documentation":"The input for a GetTemplate action.
" - }, - "output":{ - "shape":"GetTemplateOutput", - "documentation":"The output for GetTemplate action.
", - "resultWrapper":"GetTemplateResult" - }, - "documentation":"Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
ValidationError is returned. The input for the GetTemplateSummary action.
" - }, - "output":{ - "shape":"GetTemplateSummaryOutput", - "documentation":"The output for the GetTemplateSummary action.
", - "resultWrapper":"GetTemplateSummaryResult" - }, - "documentation":"Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.
You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
The input for the ListStackResource action.
" - }, - "output":{ - "shape":"ListStackResourcesOutput", - "documentation":"The output for a ListStackResources action.
", - "resultWrapper":"ListStackResourcesResult" - }, - "documentation":"Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
" - }, - "ListStacks":{ - "name":"ListStacks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListStacksInput", - "documentation":"The input for ListStacks action.
" - }, - "output":{ - "shape":"ListStacksOutput", - "documentation":"The output for ListStacks action.
", - "resultWrapper":"ListStacksResult" - }, - "documentation":"Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
" - }, - "SetStackPolicy":{ - "name":"SetStackPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetStackPolicyInput", - "documentation":"The input for the SetStackPolicy action.
" - }, - "documentation":"Sets a stack policy for a specified stack.
" - }, - "SignalResource":{ - "name":"SignalResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SignalResourceInput", - "documentation":"The input for the SignalResource action.
" - }, - "documentation":"Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
" - }, - "UpdateStack":{ - "name":"UpdateStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateStackInput", - "documentation":"The input for UpdateStack action.
" - }, - "output":{ - "shape":"UpdateStackOutput", - "documentation":"The output for a UpdateStack action.
", - "resultWrapper":"UpdateStackResult" - }, - "errors":[ - { - "shape":"InsufficientCapabilitiesException", - "error":{ - "code":"InsufficientCapabilitiesException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The template contains resources with capabilities that were not specified in the Capabilities parameter.
" - } - ], - "documentation":"Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
Tags that were associated with this stack during creation time will still be associated with the stack after an UpdateStack operation.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
" - }, - "ValidateTemplate":{ - "name":"ValidateTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ValidateTemplateInput", - "documentation":"The input for ValidateTemplate action.
" - }, - "output":{ - "shape":"ValidateTemplateOutput", - "documentation":"The output for ValidateTemplate action.
", - "resultWrapper":"ValidateTemplateResult" - }, - "documentation":"Validates a specified template.
" - } - }, - "shapes":{ - "AlreadyExistsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AlreadyExistsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Resource with the name requested already exists.
" - }, - "CancelUpdateStackInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack.
" - } - }, - "documentation":"The input for CancelUpdateStack action.
" - }, - "Capabilities":{ - "type":"list", - "member":{"shape":"Capability"} - }, - "CapabilitiesReason":{"type":"string"}, - "Capability":{ - "type":"string", - "enum":["CAPABILITY_IAM"] - }, - "CreateStackInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name associated with the stack. The name must be unique within your AWS account.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack.
Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.
Default: false
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
" - }, - "Capabilities":{ - "shape":"Capabilities", - "documentation":"A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is CAPABILITY_IAM, which is required for the following resources: AWS::CloudFormation::Stack, AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.
Default: ROLLBACK
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.
The input for CreateStack action.
" - }, - "CreateStackOutput":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"StackId", - "documentation":"Unique identifier of the stack.
" - } - }, - "documentation":"The output for a CreateStack action.
" - }, - "CreationTime":{"type":"timestamp"}, - "DeleteStackInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack.
" - } - }, - "documentation":"The input for DeleteStack action.
" - }, - "DeletionTime":{"type":"timestamp"}, - "DescribeStackEventsInput":{ - "type":"structure", - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack, which are not always interchangeable:
Default: There is no default value.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"String that identifies the start of the next list of events, if there is one.
Default: There is no default value.
" - } - }, - "documentation":"The input for DescribeStackEvents action.
" - }, - "DescribeStackEventsOutput":{ - "type":"structure", - "members":{ - "StackEvents":{ - "shape":"StackEvents", - "documentation":"A list of StackEvents structures.
String that identifies the start of the next list of events, if there is one.
" - } - }, - "documentation":"The output for a DescribeStackEvents action.
" - }, - "DescribeStackResourceInput":{ - "type":"structure", - "required":[ - "StackName", - "LogicalResourceId" - ], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack, which are not always interchangeable:
Default: There is no default value.
" - }, - "LogicalResourceId":{ - "shape":"LogicalResourceId", - "documentation":"The logical name of the resource as specified in the template.
Default: There is no default value.
" - } - }, - "documentation":"The input for DescribeStackResource action.
" - }, - "DescribeStackResourceOutput":{ - "type":"structure", - "members":{ - "StackResourceDetail":{ - "shape":"StackResourceDetail", - "documentation":"A StackResourceDetail structure containing the description of the specified resource in the specified stack.
The output for a DescribeStackResource action.
" - }, - "DescribeStackResourcesInput":{ - "type":"structure", - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack, which are not always interchangeable:
Default: There is no default value.
Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.
The logical name of the resource as specified in the template.
Default: There is no default value.
" - }, - "PhysicalResourceId":{ - "shape":"PhysicalResourceId", - "documentation":"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.
Default: There is no default value.
" - } - }, - "documentation":"The input for DescribeStackResources action.
" - }, - "DescribeStackResourcesOutput":{ - "type":"structure", - "members":{ - "StackResources":{ - "shape":"StackResources", - "documentation":"A list of StackResource structures.
The output for a DescribeStackResources action.
" - }, - "DescribeStacksInput":{ - "type":"structure", - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack, which are not always interchangeable:
Default: There is no default value.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"String that identifies the start of the next list of stacks, if there is one." - } - }, - "documentation":"The input for DescribeStacks action.
" - }, - "DescribeStacksOutput":{ - "type":"structure", - "members":{ - "Stacks":{ - "shape":"Stacks", - "documentation":"A list of stack structures.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"String that identifies the start of the next list of stacks, if there is one." - } - }, - "documentation":"The output for a DescribeStacks action.
" - }, - "Description":{"type":"string"}, - "DisableRollback":{"type":"boolean"}, - "EstimateTemplateCostInput":{ - "type":"structure", - "members":{ - "TemplateBody":{ - "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
A list of Parameter structures that specify input parameters.
An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
" - } - }, - "documentation":"The output for a EstimateTemplateCost action.
" - }, - "EventId":{"type":"string"}, - "GetStackPolicyInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or stack ID that is associated with the stack whose policy you want to get.
" - } - }, - "documentation":"The input for the GetStackPolicy action.
" - }, - "GetStackPolicyOutput":{ - "type":"structure", - "members":{ - "StackPolicyBody":{ - "shape":"StackPolicyBody", - "documentation":"Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
" - } - }, - "documentation":"The output for the GetStackPolicy action.
" - }, - "GetTemplateInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack, which are not always interchangeable:
Default: There is no default value.
" - } - }, - "documentation":"The input for a GetTemplate action.
" - }, - "GetTemplateOutput":{ - "type":"structure", - "members":{ - "TemplateBody":{ - "shape":"TemplateBody", - "documentation":"Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
" - } - }, - "documentation":"The output for GetTemplate action.
" - }, - "GetTemplateSummaryInput":{ - "type":"structure", - "members":{ - "TemplateBody":{ - "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.
The name or the unique identifier associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.
Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.
The input for the GetTemplateSummary action.
" - }, - "GetTemplateSummaryOutput":{ - "type":"structure", - "members":{ - "Parameters":{ - "shape":"ParameterDeclarations", - "documentation":"A list of parameter declarations that describe various properties for each parameter.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The value that is defined in the Description property of the template.
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
" - }, - "CapabilitiesReason":{ - "shape":"CapabilitiesReason", - "documentation":"The capabilities reason found within the template.
" - }, - "Version":{ - "shape":"Version", - "documentation":"The AWS template format version, which identifies the capabilities of the template.
" - } - }, - "documentation":"The output for the GetTemplateSummary action.
" - }, - "InsufficientCapabilitiesException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientCapabilitiesException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The template contains resources with capabilities that were not specified in the Capabilities parameter.
" - }, - "LastUpdatedTime":{"type":"timestamp"}, - "LimitExceededException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"LimitExceededException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Quota for the resource has already been reached.
" - }, - "ListStackResourcesInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or the unique identifier associated with the stack, which are not always interchangeable:
Default: There is no default value.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"String that identifies the start of the next list of stack resource summaries, if there is one.
Default: There is no default value.
" - } - }, - "documentation":"The input for the ListStackResource action.
" - }, - "ListStackResourcesOutput":{ - "type":"structure", - "members":{ - "StackResourceSummaries":{ - "shape":"StackResourceSummaries", - "documentation":"A list of StackResourceSummary structures.
String that identifies the start of the next list of stack resources, if there is one.
" - } - }, - "documentation":"The output for a ListStackResources action.
" - }, - "ListStacksInput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"String that identifies the start of the next list of stacks, if there is one.
Default: There is no default value.
" - }, - "StackStatusFilter":{ - "shape":"StackStatusFilter", - "documentation":"Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
The input for ListStacks action.
" - }, - "ListStacksOutput":{ - "type":"structure", - "members":{ - "StackSummaries":{ - "shape":"StackSummaries", - "documentation":"A list of StackSummary structures containing information about the specified stacks.
String that identifies the start of the next list of stacks, if there is one.
" - } - }, - "documentation":"The output for ListStacks action.
" - }, - "LogicalResourceId":{"type":"string"}, - "Metadata":{"type":"string"}, - "NextToken":{ - "type":"string", - "min":1, - "max":1024 - }, - "NoEcho":{"type":"boolean"}, - "NotificationARN":{"type":"string"}, - "NotificationARNs":{ - "type":"list", - "member":{"shape":"NotificationARN"}, - "max":5 - }, - "OnFailure":{ - "type":"string", - "enum":[ - "DO_NOTHING", - "ROLLBACK", - "DELETE" - ] - }, - "Output":{ - "type":"structure", - "members":{ - "OutputKey":{ - "shape":"OutputKey", - "documentation":"The key associated with the output.
" - }, - "OutputValue":{ - "shape":"OutputValue", - "documentation":"The value associated with the output.
" - }, - "Description":{ - "shape":"Description", - "documentation":"User defined description associated with the output.
" - } - }, - "documentation":"The Output data type.
" - }, - "OutputKey":{"type":"string"}, - "OutputValue":{"type":"string"}, - "Outputs":{ - "type":"list", - "member":{"shape":"Output"} - }, - "Parameter":{ - "type":"structure", - "members":{ - "ParameterKey":{ - "shape":"ParameterKey", - "documentation":"The key associated with the parameter.
" - }, - "ParameterValue":{ - "shape":"ParameterValue", - "documentation":"The value associated with the parameter.
" - }, - "UsePreviousValue":{ - "shape":"UsePreviousValue", - "documentation":"During a stack update, use the existing parameter value that is being used for the stack.
" - } - }, - "documentation":"The Parameter data type.
" - }, - "ParameterDeclaration":{ - "type":"structure", - "members":{ - "ParameterKey":{ - "shape":"ParameterKey", - "documentation":"The name that is associated with the parameter.
" - }, - "DefaultValue":{ - "shape":"ParameterValue", - "documentation":"The default value of the parameter.
" - }, - "ParameterType":{ - "shape":"ParameterType", - "documentation":"The type of parameter.
" - }, - "NoEcho":{ - "shape":"NoEcho", - "documentation":"Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The description that is associate with the parameter.
" - } - }, - "documentation":"The ParameterDeclaration data type.
" - }, - "ParameterDeclarations":{ - "type":"list", - "member":{"shape":"ParameterDeclaration"} - }, - "ParameterKey":{"type":"string"}, - "ParameterType":{"type":"string"}, - "ParameterValue":{"type":"string"}, - "Parameters":{ - "type":"list", - "member":{"shape":"Parameter"} - }, - "PhysicalResourceId":{"type":"string"}, - "ResourceProperties":{"type":"string"}, - "ResourceSignalStatus":{ - "type":"string", - "enum":[ - "SUCCESS", - "FAILURE" - ] - }, - "ResourceSignalUniqueId":{ - "type":"string", - "min":1, - "max":64 - }, - "ResourceStatus":{ - "type":"string", - "enum":[ - "CREATE_IN_PROGRESS", - "CREATE_FAILED", - "CREATE_COMPLETE", - "DELETE_IN_PROGRESS", - "DELETE_FAILED", - "DELETE_COMPLETE", - "DELETE_SKIPPED", - "UPDATE_IN_PROGRESS", - "UPDATE_FAILED", - "UPDATE_COMPLETE" - ] - }, - "ResourceStatusReason":{"type":"string"}, - "ResourceType":{"type":"string"}, - "SetStackPolicyInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or stack ID that you want to associate a policy with.
" - }, - "StackPolicyBody":{ - "shape":"StackPolicyBody", - "documentation":"Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
The input for the SetStackPolicy action.
" - }, - "SignalResourceInput":{ - "type":"structure", - "required":[ - "StackName", - "LogicalResourceId", - "UniqueId", - "Status" - ], - "members":{ - "StackName":{ - "shape":"StackNameOrId", - "documentation":"The stack name or ID that includes the resource that you want to signal.
" - }, - "LogicalResourceId":{ - "shape":"LogicalResourceId", - "documentation":"The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
" - }, - "UniqueId":{ - "shape":"ResourceSignalUniqueId", - "documentation":"A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.
" - }, - "Status":{ - "shape":"ResourceSignalStatus", - "documentation":"The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
" - } - }, - "documentation":"The input for the SignalResource action.
" - }, - "Stack":{ - "type":"structure", - "required":[ - "StackName", - "CreationTime", - "StackStatus" - ], - "members":{ - "StackId":{ - "shape":"StackId", - "documentation":"Unique identifier of the stack.
" - }, - "StackName":{ - "shape":"StackName", - "documentation":"The name associated with the stack.
" - }, - "Description":{ - "shape":"Description", - "documentation":"User defined description associated with the stack.
" - }, - "Parameters":{ - "shape":"Parameters", - "documentation":"A list of Parameter structures.
Time at which the stack was created.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
" - }, - "StackStatus":{ - "shape":"StackStatus", - "documentation":"Current status of the stack.
" - }, - "StackStatusReason":{ - "shape":"StackStatusReason", - "documentation":"Success/failure message associated with the stack status.
" - }, - "DisableRollback":{ - "shape":"DisableRollback", - "documentation":"Boolean to enable or disable rollback on stack creation failures:
true: disable rollbackfalse: enable rollbackSNS topic ARNs to which stack related events are published.
" - }, - "TimeoutInMinutes":{ - "shape":"TimeoutMinutes", - "documentation":"The amount of time within which stack creation should complete.
" - }, - "Capabilities":{ - "shape":"Capabilities", - "documentation":"The capabilities allowed in the stack.
" - }, - "Outputs":{ - "shape":"Outputs", - "documentation":"A list of output structures.
" - }, - "Tags":{ - "shape":"Tags", - "documentation":"A list of Tags that specify cost allocation information for the stack.
The Stack data type.
" - }, - "StackEvent":{ - "type":"structure", - "required":[ - "StackId", - "EventId", - "StackName", - "Timestamp" - ], - "members":{ - "StackId":{ - "shape":"StackId", - "documentation":"The unique ID name of the instance of the stack.
" - }, - "EventId":{ - "shape":"EventId", - "documentation":"The unique ID of this event.
" - }, - "StackName":{ - "shape":"StackName", - "documentation":"The name associated with a stack.
" - }, - "LogicalResourceId":{ - "shape":"LogicalResourceId", - "documentation":"The logical name of the resource specified in the template.
" - }, - "PhysicalResourceId":{ - "shape":"PhysicalResourceId", - "documentation":"The name or unique identifier associated with the physical instance of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" - }, - "Timestamp":{ - "shape":"Timestamp", - "documentation":"Time the status was updated.
" - }, - "ResourceStatus":{ - "shape":"ResourceStatus", - "documentation":"Current status of the resource.
" - }, - "ResourceStatusReason":{ - "shape":"ResourceStatusReason", - "documentation":"Success/failure message associated with the resource.
" - }, - "ResourceProperties":{ - "shape":"ResourceProperties", - "documentation":"BLOB of the properties used to create the resource.
" - } - }, - "documentation":"The StackEvent data type.
" - }, - "StackEvents":{ - "type":"list", - "member":{"shape":"StackEvent"} - }, - "StackId":{"type":"string"}, - "StackName":{"type":"string"}, - "StackNameOrId":{ - "type":"string", - "min":1, - "pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)" - }, - "StackPolicyBody":{ - "type":"string", - "min":1, - "max":16384 - }, - "StackPolicyDuringUpdateBody":{ - "type":"string", - "min":1, - "max":16384 - }, - "StackPolicyDuringUpdateURL":{ - "type":"string", - "min":1, - "max":1350 - }, - "StackPolicyURL":{ - "type":"string", - "min":1, - "max":1350 - }, - "StackResource":{ - "type":"structure", - "required":[ - "LogicalResourceId", - "ResourceType", - "Timestamp", - "ResourceStatus" - ], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name associated with the stack.
" - }, - "StackId":{ - "shape":"StackId", - "documentation":"Unique identifier of the stack.
" - }, - "LogicalResourceId":{ - "shape":"LogicalResourceId", - "documentation":"The logical name of the resource specified in the template.
" - }, - "PhysicalResourceId":{ - "shape":"PhysicalResourceId", - "documentation":"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" - }, - "Timestamp":{ - "shape":"Timestamp", - "documentation":"Time the status was updated.
" - }, - "ResourceStatus":{ - "shape":"ResourceStatus", - "documentation":"Current status of the resource.
" - }, - "ResourceStatusReason":{ - "shape":"ResourceStatusReason", - "documentation":"Success/failure message associated with the resource.
" - }, - "Description":{ - "shape":"Description", - "documentation":"User defined description associated with the resource.
" - } - }, - "documentation":"The StackResource data type.
" - }, - "StackResourceDetail":{ - "type":"structure", - "required":[ - "LogicalResourceId", - "ResourceType", - "LastUpdatedTimestamp", - "ResourceStatus" - ], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name associated with the stack.
" - }, - "StackId":{ - "shape":"StackId", - "documentation":"Unique identifier of the stack.
" - }, - "LogicalResourceId":{ - "shape":"LogicalResourceId", - "documentation":"The logical name of the resource specified in the template.
" - }, - "PhysicalResourceId":{ - "shape":"PhysicalResourceId", - "documentation":"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" - }, - "LastUpdatedTimestamp":{ - "shape":"Timestamp", - "documentation":"Time the status was updated.
" - }, - "ResourceStatus":{ - "shape":"ResourceStatus", - "documentation":"Current status of the resource.
" - }, - "ResourceStatusReason":{ - "shape":"ResourceStatusReason", - "documentation":"Success/failure message associated with the resource.
" - }, - "Description":{ - "shape":"Description", - "documentation":"User defined description associated with the resource.
" - }, - "Metadata":{ - "shape":"Metadata", - "documentation":"The JSON format content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
Contains detailed information about the specified stack resource.
" - }, - "StackResourceSummaries":{ - "type":"list", - "member":{"shape":"StackResourceSummary"} - }, - "StackResourceSummary":{ - "type":"structure", - "required":[ - "LogicalResourceId", - "ResourceType", - "LastUpdatedTimestamp", - "ResourceStatus" - ], - "members":{ - "LogicalResourceId":{ - "shape":"LogicalResourceId", - "documentation":"The logical name of the resource specified in the template.
" - }, - "PhysicalResourceId":{ - "shape":"PhysicalResourceId", - "documentation":"The name or unique identifier that corresponds to a physical instance ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" - }, - "LastUpdatedTimestamp":{ - "shape":"Timestamp", - "documentation":"Time the status was updated.
" - }, - "ResourceStatus":{ - "shape":"ResourceStatus", - "documentation":"Current status of the resource.
" - }, - "ResourceStatusReason":{ - "shape":"ResourceStatusReason", - "documentation":"Success/failure message associated with the resource.
" - } - }, - "documentation":"Contains high-level information about the specified stack resource.
" - }, - "StackResources":{ - "type":"list", - "member":{"shape":"StackResource"} - }, - "StackStatus":{ - "type":"string", - "enum":[ - "CREATE_IN_PROGRESS", - "CREATE_FAILED", - "CREATE_COMPLETE", - "ROLLBACK_IN_PROGRESS", - "ROLLBACK_FAILED", - "ROLLBACK_COMPLETE", - "DELETE_IN_PROGRESS", - "DELETE_FAILED", - "DELETE_COMPLETE", - "UPDATE_IN_PROGRESS", - "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", - "UPDATE_COMPLETE", - "UPDATE_ROLLBACK_IN_PROGRESS", - "UPDATE_ROLLBACK_FAILED", - "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", - "UPDATE_ROLLBACK_COMPLETE" - ] - }, - "StackStatusFilter":{ - "type":"list", - "member":{"shape":"StackStatus"} - }, - "StackStatusReason":{"type":"string"}, - "StackSummaries":{ - "type":"list", - "member":{"shape":"StackSummary"} - }, - "StackSummary":{ - "type":"structure", - "required":[ - "StackName", - "CreationTime", - "StackStatus" - ], - "members":{ - "StackId":{ - "shape":"StackId", - "documentation":"Unique stack identifier.
" - }, - "StackName":{ - "shape":"StackName", - "documentation":"The name associated with the stack.
" - }, - "TemplateDescription":{ - "shape":"TemplateDescription", - "documentation":"The template description of the template used to create the stack.
" - }, - "CreationTime":{ - "shape":"CreationTime", - "documentation":"The time the stack was created.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
" - }, - "DeletionTime":{ - "shape":"DeletionTime", - "documentation":"The time the stack was deleted.
" - }, - "StackStatus":{ - "shape":"StackStatus", - "documentation":"The current status of the stack.
" - }, - "StackStatusReason":{ - "shape":"StackStatusReason", - "documentation":"Success/Failure message associated with the stack status.
" - } - }, - "documentation":"The StackSummary Data Type
" - }, - "Stacks":{ - "type":"list", - "member":{"shape":"Stack"} - }, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
" - } - }, - "documentation":"The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.
The name associated with the parameter.
" - }, - "DefaultValue":{ - "shape":"ParameterValue", - "documentation":"The default value associated with the parameter.
" - }, - "NoEcho":{ - "shape":"NoEcho", - "documentation":"Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
" - }, - "Description":{ - "shape":"Description", - "documentation":"User defined description associated with the parameter.
" - } - }, - "documentation":"The TemplateParameter data type.
" - }, - "TemplateParameters":{ - "type":"list", - "member":{"shape":"TemplateParameter"} - }, - "TemplateURL":{ - "type":"string", - "min":1, - "max":1024 - }, - "TimeoutMinutes":{ - "type":"integer", - "min":1 - }, - "Timestamp":{"type":"timestamp"}, - "UpdateStackInput":{ - "type":"structure", - "required":["StackName"], - "members":{ - "StackName":{ - "shape":"StackName", - "documentation":"The name or stack ID of the stack to update.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Reuse the existing template that is associated with the stack that you are updating.
" - }, - "StackPolicyDuringUpdateBody":{ - "shape":"StackPolicyDuringUpdateBody", - "documentation":"Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
" - }, - "StackPolicyDuringUpdateURL":{ - "shape":"StackPolicyDuringUpdateURL", - "documentation":"Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
" - }, - "Parameters":{ - "shape":"Parameters", - "documentation":"A list of Parameter structures that specify input parameters for the stack.
A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. Currently, the only valid value is CAPABILITY_IAM, which is required for the following resources: AWS::CloudFormation::Stack, AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
" - }, - "StackPolicyURL":{ - "shape":"StackPolicyURL", - "documentation":"Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
" - }, - "NotificationARNs":{ - "shape":"NotificationARNs", - "documentation":"Update the ARNs for the Amazon SNS topics that are associated with the stack.
" - } - }, - "documentation":"The input for UpdateStack action.
" - }, - "UpdateStackOutput":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"StackId", - "documentation":"Unique identifier of the stack.
" - } - }, - "documentation":"The output for a UpdateStack action.
" - }, - "Url":{"type":"string"}, - "UsePreviousTemplate":{"type":"boolean"}, - "UsePreviousValue":{"type":"boolean"}, - "ValidateTemplateInput":{ - "type":"structure", - "members":{ - "TemplateBody":{ - "shape":"TemplateBody", - "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
The input for ValidateTemplate action.
" - }, - "ValidateTemplateOutput":{ - "type":"structure", - "members":{ - "Parameters":{ - "shape":"TemplateParameters", - "documentation":"A list of TemplateParameter structures.
The description found within the template.
" - }, - "Capabilities":{ - "shape":"Capabilities", - "documentation":"The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
" - }, - "CapabilitiesReason":{ - "shape":"CapabilitiesReason", - "documentation":"The capabilities reason found within the template.
" - } - }, - "documentation":"The output for ValidateTemplate action.
" - }, - "Version":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudformation/2010-05-15.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudformation/2010-05-15.paginators.json deleted file mode 100644 index 4a7474ab77..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudformation/2010-05-15.paginators.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "pagination": { - "DescribeStackEvents": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "StackEvents" - }, - "DescribeStacks": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "Stacks" - }, - "ListStackResources": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "StackResourceSummaries" - }, - "ListStacks": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "StackSummaries" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.normal.json deleted file mode 100644 index 975a649646..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.normal.json +++ /dev/null @@ -1,3540 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-05-31", - "endpointPrefix":"cloudfront", - "globalEndpoint":"cloudfront.amazonaws.com", - "serviceAbbreviation":"CloudFront", - "serviceFullName":"Amazon CloudFront", - "signatureVersion":"v4", - "protocol":"rest-xml" - }, - "operations":{ - "CreateCloudFrontOriginAccessIdentity":{ - "name":"CreateCloudFrontOriginAccessIdentity2014_05_31", - "http":{ - "method":"POST", - "requestUri":"/2014-05-31/origin-access-identity/cloudfront", - "responseCode":201 - }, - "input":{ - "shape":"CreateCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to create a new origin access identity." - }, - "output":{ - "shape":"CreateCloudFrontOriginAccessIdentityResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"CloudFrontOriginAccessIdentityAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"TooManyCloudFrontOriginAccessIdentities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Create a new origin access identity." - }, - "CreateDistribution":{ - "name":"CreateDistribution2014_05_31", - "http":{ - "method":"POST", - "requestUri":"/2014-05-31/distribution", - "responseCode":201 - }, - "input":{ - "shape":"CreateDistributionRequest", - "documentation":"The request to create a new distribution." - }, - "output":{ - "shape":"CreateDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"DistributionAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." - }, - { - "shape":"InvalidOrigin", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"InvalidViewerCertificate", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"TooManyDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more CNAMEs than are allowed per distribution." - }, - { - "shape":"TooManyDistributions", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." - }, - { - "shape":"InvalidDefaultRootObject", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The default root object file name is too big or contains an invalid character." - }, - { - "shape":"InvalidRelativePath", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." - }, - { - "shape":"InvalidErrorCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidResponseCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InvalidRequiredProtocol", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." - }, - { - "shape":"NoSuchOrigin", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"No origin exists with the specified Origin Id." - }, - { - "shape":"TooManyOrigins", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore origins for the distribution." - }, - { - "shape":"TooManyCacheBehaviors", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore cache behaviors for the distribution." - }, - { - "shape":"TooManyCookieNamesInWhiteList", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." - }, - { - "shape":"InvalidForwardCookies", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." - }, - { - "shape":"TooManyHeadersInForwardedValues", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidHeadersForS3Origin", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - }, - { - "shape":"TooManyCertificates", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore custom ssl certificates." - }, - { - "shape":"InvalidLocationCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidGeoRestrictionParameter", - "error":{"httpStatusCode":400}, - "exception":true - } - ], - "documentation":"Create a new distribution." - }, - "CreateInvalidation":{ - "name":"CreateInvalidation2014_05_31", - "http":{ - "method":"POST", - "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation", - "responseCode":201 - }, - "input":{ - "shape":"CreateInvalidationRequest", - "documentation":"The request to create an invalidation." - }, - "output":{ - "shape":"CreateInvalidationResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"BatchTooLarge", - "error":{"httpStatusCode":413}, - "exception":true - }, - { - "shape":"TooManyInvalidationsInProgress", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Create a new invalidation." - }, - "CreateStreamingDistribution":{ - "name":"CreateStreamingDistribution2014_05_31", - "http":{ - "method":"POST", - "requestUri":"/2014-05-31/streaming-distribution", - "responseCode":201 - }, - "input":{ - "shape":"CreateStreamingDistributionRequest", - "documentation":"The request to create a new streaming distribution." - }, - "output":{ - "shape":"CreateStreamingDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"StreamingDistributionAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"InvalidOrigin", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"TooManyStreamingDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"TooManyStreamingDistributions", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Create a new streaming distribution." - }, - "DeleteCloudFrontOriginAccessIdentity":{ - "name":"DeleteCloudFrontOriginAccessIdentity2014_05_31", - "http":{ - "method":"DELETE", - "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to delete a origin access identity." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"CloudFrontOriginAccessIdentityInUse", - "error":{"httpStatusCode":409}, - "exception":true - } - ], - "documentation":"Delete an origin access identity." - }, - "DeleteDistribution":{ - "name":"DeleteDistribution2014_05_31", - "http":{ - "method":"DELETE", - "requestUri":"/2014-05-31/distribution/{Id}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteDistributionRequest", - "documentation":"The request to delete a distribution." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"DistributionNotDisabled", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - } - ], - "documentation":"Delete a distribution." - }, - "DeleteStreamingDistribution":{ - "name":"DeleteStreamingDistribution2014_05_31", - "http":{ - "method":"DELETE", - "requestUri":"/2014-05-31/streaming-distribution/{Id}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteStreamingDistributionRequest", - "documentation":"The request to delete a streaming distribution." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"StreamingDistributionNotDisabled", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - } - ], - "documentation":"Delete a streaming distribution." - }, - "GetCloudFrontOriginAccessIdentity":{ - "name":"GetCloudFrontOriginAccessIdentity2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}" - }, - "input":{ - "shape":"GetCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to get an origin access identity's information." - }, - "output":{ - "shape":"GetCloudFrontOriginAccessIdentityResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about an origin access identity." - }, - "GetCloudFrontOriginAccessIdentityConfig":{ - "name":"GetCloudFrontOriginAccessIdentityConfig2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" - }, - "input":{ - "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", - "documentation":"The request to get an origin access identity's configuration." - }, - "output":{ - "shape":"GetCloudFrontOriginAccessIdentityConfigResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the configuration information about an origin access identity." - }, - "GetDistribution":{ - "name":"GetDistribution2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/distribution/{Id}" - }, - "input":{ - "shape":"GetDistributionRequest", - "documentation":"The request to get a distribution's information." - }, - "output":{ - "shape":"GetDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about a distribution." - }, - "GetDistributionConfig":{ - "name":"GetDistributionConfig2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/distribution/{Id}/config" - }, - "input":{ - "shape":"GetDistributionConfigRequest", - "documentation":"The request to get a distribution configuration." - }, - "output":{ - "shape":"GetDistributionConfigResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the configuration information about a distribution." - }, - "GetInvalidation":{ - "name":"GetInvalidation2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation/{Id}" - }, - "input":{ - "shape":"GetInvalidationRequest", - "documentation":"The request to get an invalidation's information." - }, - "output":{ - "shape":"GetInvalidationResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchInvalidation", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified invalidation does not exist." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about an invalidation." - }, - "GetStreamingDistribution":{ - "name":"GetStreamingDistribution2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/streaming-distribution/{Id}" - }, - "input":{ - "shape":"GetStreamingDistributionRequest", - "documentation":"The request to get a streaming distribution's information." - }, - "output":{ - "shape":"GetStreamingDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about a streaming distribution." - }, - "GetStreamingDistributionConfig":{ - "name":"GetStreamingDistributionConfig2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" - }, - "input":{ - "shape":"GetStreamingDistributionConfigRequest", - "documentation":"To request to get a streaming distribution configuration." - }, - "output":{ - "shape":"GetStreamingDistributionConfigResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the configuration information about a streaming distribution." - }, - "ListCloudFrontOriginAccessIdentities":{ - "name":"ListCloudFrontOriginAccessIdentities2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/origin-access-identity/cloudfront" - }, - "input":{ - "shape":"ListCloudFrontOriginAccessIdentitiesRequest", - "documentation":"The request to list origin access identities." - }, - "output":{ - "shape":"ListCloudFrontOriginAccessIdentitiesResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - } - ], - "documentation":"List origin access identities." - }, - "ListDistributions":{ - "name":"ListDistributions2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/distribution" - }, - "input":{ - "shape":"ListDistributionsRequest", - "documentation":"The request to list your distributions." - }, - "output":{ - "shape":"ListDistributionsResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - } - ], - "documentation":"List distributions." - }, - "ListInvalidations":{ - "name":"ListInvalidations2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation" - }, - "input":{ - "shape":"ListInvalidationsRequest", - "documentation":"The request to list invalidations." - }, - "output":{ - "shape":"ListInvalidationsResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"List invalidation batches." - }, - "ListStreamingDistributions":{ - "name":"ListStreamingDistributions2014_05_31", - "http":{ - "method":"GET", - "requestUri":"/2014-05-31/streaming-distribution" - }, - "input":{ - "shape":"ListStreamingDistributionsRequest", - "documentation":"The request to list your streaming distributions." - }, - "output":{ - "shape":"ListStreamingDistributionsResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - } - ], - "documentation":"List streaming distributions." - }, - "UpdateCloudFrontOriginAccessIdentity":{ - "name":"UpdateCloudFrontOriginAccessIdentity2014_05_31", - "http":{ - "method":"PUT", - "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" - }, - "input":{ - "shape":"UpdateCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to update an origin access identity." - }, - "output":{ - "shape":"UpdateCloudFrontOriginAccessIdentityResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"IllegalUpdate", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Update an origin access identity." - }, - "UpdateDistribution":{ - "name":"UpdateDistribution2014_05_31", - "http":{ - "method":"PUT", - "requestUri":"/2014-05-31/distribution/{Id}/config" - }, - "input":{ - "shape":"UpdateDistributionRequest", - "documentation":"The request to update a distribution." - }, - "output":{ - "shape":"UpdateDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"IllegalUpdate", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"TooManyDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more CNAMEs than are allowed per distribution." - }, - { - "shape":"InvalidDefaultRootObject", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The default root object file name is too big or contains an invalid character." - }, - { - "shape":"InvalidRelativePath", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." - }, - { - "shape":"InvalidErrorCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidResponseCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"InvalidViewerCertificate", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidRequiredProtocol", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." - }, - { - "shape":"NoSuchOrigin", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"No origin exists with the specified Origin Id." - }, - { - "shape":"TooManyOrigins", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore origins for the distribution." - }, - { - "shape":"TooManyCacheBehaviors", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore cache behaviors for the distribution." - }, - { - "shape":"TooManyCookieNamesInWhiteList", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." - }, - { - "shape":"InvalidForwardCookies", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." - }, - { - "shape":"TooManyHeadersInForwardedValues", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidHeadersForS3Origin", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - }, - { - "shape":"TooManyCertificates", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore custom ssl certificates." - }, - { - "shape":"InvalidLocationCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidGeoRestrictionParameter", - "error":{"httpStatusCode":400}, - "exception":true - } - ], - "documentation":"Update a distribution." - }, - "UpdateStreamingDistribution":{ - "name":"UpdateStreamingDistribution2014_05_31", - "http":{ - "method":"PUT", - "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" - }, - "input":{ - "shape":"UpdateStreamingDistributionRequest", - "documentation":"The request to update a streaming distribution." - }, - "output":{ - "shape":"UpdateStreamingDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"IllegalUpdate", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"TooManyStreamingDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Update a streaming distribution." - } - }, - "shapes":{ - "AccessDenied":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - "ActiveTrustedSigners":{ - "type":"structure", - "required":[ - "Enabled", - "Quantity" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Each active trusted signer." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." - }, - "Items":{ - "shape":"SignerList", - "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." - } - }, - "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." - }, - "AliasList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"CNAME" - } - }, - "Aliases":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of CNAMEs, if any, for this distribution." - }, - "Items":{ - "shape":"AliasList", - "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." - }, - "AllowedMethods":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests)." - }, - "Items":{ - "shape":"AllowedMethodsList", - "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." - } - }, - "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are two options: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests. If you choose the second option, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." - }, - "AllowedMethodsList":{ - "type":"list", - "member":{ - "shape":"Method", - "locationName":"Method" - } - }, - "AwsAccountNumberList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"AwsAccountNumber" - } - }, - "BatchTooLarge":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":413}, - "exception":true - }, - "CNAMEAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "CacheBehavior":{ - "type":"structure", - "required":[ - "PathPattern", - "TargetOriginId", - "ForwardedValues", - "TrustedSigners", - "ViewerProtocolPolicy", - "MinTTL" - ], - "members":{ - "PathPattern":{ - "shape":"string", - "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." - }, - "TargetOriginId":{ - "shape":"string", - "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." - }, - "ForwardedValues":{ - "shape":"ForwardedValues", - "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "ViewerProtocolPolicy":{ - "shape":"ViewerProtocolPolicy", - "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." - }, - "MinTTL":{ - "shape":"long", - "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." - }, - "AllowedMethods":{"shape":"AllowedMethods"}, - "SmoothStreaming":{ - "shape":"boolean", - "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." - } - }, - "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." - }, - "CacheBehaviorList":{ - "type":"list", - "member":{ - "shape":"CacheBehavior", - "locationName":"CacheBehavior" - } - }, - "CacheBehaviors":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of cache behaviors for this distribution." - }, - "Items":{ - "shape":"CacheBehaviorList", - "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that contains zero or more CacheBehavior elements." - }, - "CloudFrontOriginAccessIdentity":{ - "type":"structure", - "required":[ - "Id", - "S3CanonicalUserId" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." - }, - "S3CanonicalUserId":{ - "shape":"string", - "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." - }, - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The current configuration information for the identity." - } - }, - "documentation":"CloudFront origin access identity." - }, - "CloudFrontOriginAccessIdentityAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." - }, - "CloudFrontOriginAccessIdentityConfig":{ - "type":"structure", - "required":[ - "CallerReference", - "Comment" - ], - "members":{ - "CallerReference":{ - "shape":"string", - "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." - }, - "Comment":{ - "shape":"string", - "documentation":"Any comments you want to include about the origin access identity." - } - }, - "documentation":"Origin access identity configuration." - }, - "CloudFrontOriginAccessIdentityInUse":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "CloudFrontOriginAccessIdentityList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." - }, - "Items":{ - "shape":"CloudFrontOriginAccessIdentitySummaryList", - "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." - } - }, - "documentation":"The CloudFrontOriginAccessIdentityList type." - }, - "CloudFrontOriginAccessIdentitySummary":{ - "type":"structure", - "required":[ - "Id", - "S3CanonicalUserId", - "Comment" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." - }, - "S3CanonicalUserId":{ - "shape":"string", - "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." - }, - "Comment":{ - "shape":"string", - "documentation":"The comment for this origin access identity, as originally specified when created." - } - }, - "documentation":"Summary of the information about a CloudFront origin access identity." - }, - "CloudFrontOriginAccessIdentitySummaryList":{ - "type":"list", - "member":{ - "shape":"CloudFrontOriginAccessIdentitySummary", - "locationName":"CloudFrontOriginAccessIdentitySummary" - } - }, - "CookieNameList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Name" - } - }, - "CookieNames":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of whitelisted cookies for this cache behavior." - }, - "Items":{ - "shape":"CookieNameList", - "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." - }, - "CookiePreference":{ - "type":"structure", - "required":["Forward"], - "members":{ - "Forward":{ - "shape":"ItemSelection", - "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." - }, - "WhitelistedNames":{ - "shape":"CookieNames", - "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." - } - }, - "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." - }, - "CreateCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "required":["CloudFrontOriginAccessIdentityConfig"], - "members":{ - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The origin access identity's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"CloudFrontOriginAccessIdentityConfig" - } - }, - "documentation":"The request to create a new origin access identity.", - "payload":"CloudFrontOriginAccessIdentityConfig" - }, - "CreateCloudFrontOriginAccessIdentityResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentity":{ - "shape":"CloudFrontOriginAccessIdentity", - "documentation":"The origin access identity's information." - }, - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the origin access identity created." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentity" - }, - "CreateDistributionRequest":{ - "type":"structure", - "required":["DistributionConfig"], - "members":{ - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"DistributionConfig" - } - }, - "documentation":"The request to create a new distribution.", - "payload":"DistributionConfig" - }, - "CreateDistributionResult":{ - "type":"structure", - "members":{ - "Distribution":{ - "shape":"Distribution", - "documentation":"The distribution's information." - }, - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the distribution created." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Distribution" - }, - "CreateInvalidationRequest":{ - "type":"structure", - "required":[ - "DistributionId", - "InvalidationBatch" - ], - "members":{ - "DistributionId":{ - "shape":"string", - "location":"uri", - "locationName":"DistributionId", - "documentation":"The distribution's id." - }, - "InvalidationBatch":{ - "shape":"InvalidationBatch", - "documentation":"The batch information for the invalidation.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"InvalidationBatch" - } - }, - "documentation":"The request to create an invalidation.", - "payload":"InvalidationBatch" - }, - "CreateInvalidationResult":{ - "type":"structure", - "members":{ - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." - }, - "Invalidation":{ - "shape":"Invalidation", - "documentation":"The invalidation's information." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Invalidation" - }, - "CreateStreamingDistributionRequest":{ - "type":"structure", - "required":["StreamingDistributionConfig"], - "members":{ - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The streaming distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"StreamingDistributionConfig" - } - }, - "documentation":"The request to create a new streaming distribution.", - "payload":"StreamingDistributionConfig" - }, - "CreateStreamingDistributionResult":{ - "type":"structure", - "members":{ - "StreamingDistribution":{ - "shape":"StreamingDistribution", - "documentation":"The streaming distribution's information." - }, - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the streaming distribution created." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistribution" - }, - "CustomErrorResponse":{ - "type":"structure", - "required":["ErrorCode"], - "members":{ - "ErrorCode":{ - "shape":"integer", - "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." - }, - "ResponsePagePath":{ - "shape":"string", - "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." - }, - "ResponseCode":{ - "shape":"string", - "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." - }, - "ErrorCachingMinTTL":{ - "shape":"long", - "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." - } - }, - "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." - }, - "CustomErrorResponseList":{ - "type":"list", - "member":{ - "shape":"CustomErrorResponse", - "locationName":"CustomErrorResponse" - } - }, - "CustomErrorResponses":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of custom error responses for this distribution." - }, - "Items":{ - "shape":"CustomErrorResponseList", - "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that contains zero or more CustomErrorResponse elements." - }, - "CustomOriginConfig":{ - "type":"structure", - "required":[ - "HTTPPort", - "HTTPSPort", - "OriginProtocolPolicy" - ], - "members":{ - "HTTPPort":{ - "shape":"integer", - "documentation":"The HTTP port the custom origin listens on." - }, - "HTTPSPort":{ - "shape":"integer", - "documentation":"The HTTPS port the custom origin listens on." - }, - "OriginProtocolPolicy":{ - "shape":"OriginProtocolPolicy", - "documentation":"The origin protocol policy to apply to your origin." - } - }, - "documentation":"A customer origin." - }, - "DefaultCacheBehavior":{ - "type":"structure", - "required":[ - "TargetOriginId", - "ForwardedValues", - "TrustedSigners", - "ViewerProtocolPolicy", - "MinTTL" - ], - "members":{ - "TargetOriginId":{ - "shape":"string", - "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." - }, - "ForwardedValues":{ - "shape":"ForwardedValues", - "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "ViewerProtocolPolicy":{ - "shape":"ViewerProtocolPolicy", - "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." - }, - "MinTTL":{ - "shape":"long", - "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." - }, - "AllowedMethods":{"shape":"AllowedMethods"}, - "SmoothStreaming":{ - "shape":"boolean", - "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." - } - }, - "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." - }, - "DeleteCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The origin access identity's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to delete a origin access identity.", - "required":["Id"] - }, - "DeleteDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to delete a distribution.", - "required":["Id"] - }, - "DeleteStreamingDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to delete a streaming distribution.", - "required":["Id"] - }, - "Distribution":{ - "type":"structure", - "required":[ - "Id", - "Status", - "LastModifiedTime", - "InProgressInvalidationBatches", - "DomainName", - "ActiveTrustedSigners", - "DistributionConfig" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "InProgressInvalidationBatches":{ - "shape":"integer", - "documentation":"The number of invalidation batches currently in progress." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." - }, - "ActiveTrustedSigners":{ - "shape":"ActiveTrustedSigners", - "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." - }, - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The current configuration information for the distribution." - } - }, - "documentation":"A distribution." - }, - "DistributionAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." - }, - "DistributionConfig":{ - "type":"structure", - "required":[ - "CallerReference", - "Aliases", - "DefaultRootObject", - "Origins", - "DefaultCacheBehavior", - "CacheBehaviors", - "Comment", - "Logging", - "PriceClass", - "Enabled" - ], - "members":{ - "CallerReference":{ - "shape":"string", - "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." - }, - "DefaultRootObject":{ - "shape":"string", - "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." - }, - "Origins":{ - "shape":"Origins", - "documentation":"A complex type that contains information about origins for this distribution." - }, - "DefaultCacheBehavior":{ - "shape":"DefaultCacheBehavior", - "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." - }, - "CacheBehaviors":{ - "shape":"CacheBehaviors", - "documentation":"A complex type that contains zero or more CacheBehavior elements." - }, - "CustomErrorResponses":{ - "shape":"CustomErrorResponses", - "documentation":"A complex type that contains zero or more CustomErrorResponse elements." - }, - "Comment":{ - "shape":"string", - "documentation":"Any comments you want to include about the distribution." - }, - "Logging":{ - "shape":"LoggingConfig", - "documentation":"A complex type that controls whether access logs are written for the distribution." - }, - "PriceClass":{ - "shape":"PriceClass", - "documentation":"A complex type that contains information about price class for this distribution." - }, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the distribution is enabled to accept end user requests for content." - }, - "ViewerCertificate":{"shape":"ViewerCertificate"}, - "Restrictions":{"shape":"Restrictions"} - }, - "documentation":"A distribution Configuration." - }, - "DistributionList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of distributions that were created by the current AWS account." - }, - "Items":{ - "shape":"DistributionSummaryList", - "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." - } - }, - "documentation":"A distribution list." - }, - "DistributionNotDisabled":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "DistributionSummary":{ - "type":"structure", - "required":[ - "Id", - "Status", - "LastModifiedTime", - "DomainName", - "Aliases", - "Origins", - "DefaultCacheBehavior", - "CacheBehaviors", - "CustomErrorResponses", - "Comment", - "PriceClass", - "Enabled", - "ViewerCertificate", - "Restrictions" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." - }, - "Origins":{ - "shape":"Origins", - "documentation":"A complex type that contains information about origins for this distribution." - }, - "DefaultCacheBehavior":{ - "shape":"DefaultCacheBehavior", - "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." - }, - "CacheBehaviors":{ - "shape":"CacheBehaviors", - "documentation":"A complex type that contains zero or more CacheBehavior elements." - }, - "CustomErrorResponses":{ - "shape":"CustomErrorResponses", - "documentation":"A complex type that contains zero or more CustomErrorResponses elements." - }, - "Comment":{ - "shape":"string", - "documentation":"The comment originally specified when this distribution was created." - }, - "PriceClass":{"shape":"PriceClass"}, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the distribution is enabled to accept end user requests for content." - }, - "ViewerCertificate":{"shape":"ViewerCertificate"}, - "Restrictions":{"shape":"Restrictions"} - }, - "documentation":"A summary of the information for an Amazon CloudFront distribution." - }, - "DistributionSummaryList":{ - "type":"list", - "member":{ - "shape":"DistributionSummary", - "locationName":"DistributionSummary" - } - }, - "ForwardedValues":{ - "type":"structure", - "required":[ - "QueryString", - "Cookies" - ], - "members":{ - "QueryString":{ - "shape":"boolean", - "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." - }, - "Cookies":{ - "shape":"CookiePreference", - "documentation":"A complex type that specifies how CloudFront handles cookies." - }, - "Headers":{ - "shape":"Headers", - "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." - } - }, - "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." - }, - "GeoRestriction":{ - "type":"structure", - "required":[ - "RestrictionType", - "Quantity" - ], - "members":{ - "RestrictionType":{ - "shape":"GeoRestrictionType", - "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." - }, - "Quantity":{ - "shape":"integer", - "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." - }, - "Items":{ - "shape":"LocationList", - "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." - } - }, - "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." - }, - "GeoRestrictionType":{ - "type":"string", - "enum":[ - "blacklist", - "whitelist", - "none" - ] - }, - "GetCloudFrontOriginAccessIdentityConfigRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The identity's id." - } - }, - "documentation":"The request to get an origin access identity's configuration.", - "required":["Id"] - }, - "GetCloudFrontOriginAccessIdentityConfigResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The origin access identity's configuration information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentityConfig" - }, - "GetCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The identity's id." - } - }, - "documentation":"The request to get an origin access identity's information.", - "required":["Id"] - }, - "GetCloudFrontOriginAccessIdentityResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentity":{ - "shape":"CloudFrontOriginAccessIdentity", - "documentation":"The origin access identity's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentity" - }, - "GetDistributionConfigRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution's id." - } - }, - "documentation":"The request to get a distribution configuration.", - "required":["Id"] - }, - "GetDistributionConfigResult":{ - "type":"structure", - "members":{ - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The distribution's configuration information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"DistributionConfig" - }, - "GetDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution's id." - } - }, - "documentation":"The request to get a distribution's information.", - "required":["Id"] - }, - "GetDistributionResult":{ - "type":"structure", - "members":{ - "Distribution":{ - "shape":"Distribution", - "documentation":"The distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Distribution" - }, - "GetInvalidationRequest":{ - "type":"structure", - "required":[ - "DistributionId", - "Id" - ], - "members":{ - "DistributionId":{ - "shape":"string", - "location":"uri", - "locationName":"DistributionId", - "documentation":"The distribution's id." - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The invalidation's id." - } - }, - "documentation":"The request to get an invalidation's information." - }, - "GetInvalidationResult":{ - "type":"structure", - "members":{ - "Invalidation":{ - "shape":"Invalidation", - "documentation":"The invalidation's information." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Invalidation" - }, - "GetStreamingDistributionConfigRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The streaming distribution's id." - } - }, - "documentation":"To request to get a streaming distribution configuration.", - "required":["Id"] - }, - "GetStreamingDistributionConfigResult":{ - "type":"structure", - "members":{ - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The streaming distribution's configuration information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistributionConfig" - }, - "GetStreamingDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The streaming distribution's id." - } - }, - "documentation":"The request to get a streaming distribution's information.", - "required":["Id"] - }, - "GetStreamingDistributionResult":{ - "type":"structure", - "members":{ - "StreamingDistribution":{ - "shape":"StreamingDistribution", - "documentation":"The streaming distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistribution" - }, - "HeaderList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Name" - } - }, - "Headers":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." - }, - "Items":{ - "shape":"HeaderList", - "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." - } - }, - "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." - }, - "IllegalUpdate":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - "InconsistentQuantities":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - }, - "InvalidArgument":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - "InvalidDefaultRootObject":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The default root object file name is too big or contains an invalid character." - }, - "InvalidErrorCode":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidForwardCookies":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." - }, - "InvalidGeoRestrictionParameter":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidHeadersForS3Origin":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidIfMatchVersion":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - "InvalidLocationCode":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidOrigin":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." - }, - "InvalidOriginAccessIdentity":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - "InvalidRelativePath":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." - }, - "InvalidRequiredProtocol":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." - }, - "InvalidResponseCode":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidViewerCertificate":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "Invalidation":{ - "type":"structure", - "required":[ - "Id", - "Status", - "CreateTime", - "InvalidationBatch" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." - }, - "CreateTime":{ - "shape":"timestamp", - "documentation":"The date and time the invalidation request was first made." - }, - "InvalidationBatch":{ - "shape":"InvalidationBatch", - "documentation":"The current invalidation information for the batch request." - } - }, - "documentation":"An invalidation." - }, - "InvalidationBatch":{ - "type":"structure", - "required":[ - "Paths", - "CallerReference" - ], - "members":{ - "Paths":{ - "shape":"Paths", - "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." - }, - "CallerReference":{ - "shape":"string", - "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." - } - }, - "documentation":"An invalidation batch." - }, - "InvalidationList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of invalidation batches that were created by the current AWS account." - }, - "Items":{ - "shape":"InvalidationSummaryList", - "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." - } - }, - "documentation":"An invalidation list." - }, - "InvalidationSummary":{ - "type":"structure", - "required":[ - "Id", - "CreateTime", - "Status" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The unique ID for an invalidation request." - }, - "CreateTime":{"shape":"timestamp"}, - "Status":{ - "shape":"string", - "documentation":"The status of an invalidation request." - } - }, - "documentation":"Summary of an invalidation request." - }, - "InvalidationSummaryList":{ - "type":"list", - "member":{ - "shape":"InvalidationSummary", - "locationName":"InvalidationSummary" - } - }, - "ItemSelection":{ - "type":"string", - "enum":[ - "none", - "whitelist", - "all" - ] - }, - "KeyPairIdList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"KeyPairId" - } - }, - "KeyPairIds":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." - }, - "Items":{ - "shape":"KeyPairIdList", - "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." - } - }, - "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." - }, - "ListCloudFrontOriginAccessIdentitiesRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of origin access identities you want in the response body." - } - }, - "documentation":"The request to list origin access identities." - }, - "ListCloudFrontOriginAccessIdentitiesResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentityList":{ - "shape":"CloudFrontOriginAccessIdentityList", - "documentation":"The CloudFrontOriginAccessIdentityList type." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentityList" - }, - "ListDistributionsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of distributions you want in the response body." - } - }, - "documentation":"The request to list your distributions." - }, - "ListDistributionsResult":{ - "type":"structure", - "members":{ - "DistributionList":{ - "shape":"DistributionList", - "documentation":"The DistributionList type." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"DistributionList" - }, - "ListInvalidationsRequest":{ - "type":"structure", - "required":["DistributionId"], - "members":{ - "DistributionId":{ - "shape":"string", - "location":"uri", - "locationName":"DistributionId", - "documentation":"The distribution's id." - }, - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of invalidation batches you want in the response body." - } - }, - "documentation":"The request to list invalidations." - }, - "ListInvalidationsResult":{ - "type":"structure", - "members":{ - "InvalidationList":{ - "shape":"InvalidationList", - "documentation":"Information about invalidation batches." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"InvalidationList" - }, - "ListStreamingDistributionsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of streaming distributions you want in the response body." - } - }, - "documentation":"The request to list your streaming distributions." - }, - "ListStreamingDistributionsResult":{ - "type":"structure", - "members":{ - "StreamingDistributionList":{ - "shape":"StreamingDistributionList", - "documentation":"The StreamingDistributionList type." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistributionList" - }, - "LocationList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Location" - } - }, - "LoggingConfig":{ - "type":"structure", - "required":[ - "Enabled", - "IncludeCookies", - "Bucket", - "Prefix" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." - }, - "IncludeCookies":{ - "shape":"boolean", - "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." - }, - "Bucket":{ - "shape":"string", - "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." - }, - "Prefix":{ - "shape":"string", - "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." - } - }, - "documentation":"A complex type that controls whether access logs are written for the distribution." - }, - "Method":{ - "type":"string", - "enum":[ - "GET", - "HEAD", - "POST", - "PUT", - "PATCH", - "OPTIONS", - "DELETE" - ] - }, - "MissingBody":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - "NoSuchCloudFrontOriginAccessIdentity":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - "NoSuchDistribution":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - "NoSuchInvalidation":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified invalidation does not exist." - }, - "NoSuchOrigin":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"No origin exists with the specified Origin Id." - }, - "NoSuchStreamingDistribution":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - "Origin":{ - "type":"structure", - "required":[ - "Id", - "DomainName" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." - }, - "DomainName":{ - "shape":"string", - "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." - }, - "S3OriginConfig":{ - "shape":"S3OriginConfig", - "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." - }, - "CustomOriginConfig":{ - "shape":"CustomOriginConfig", - "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." - } - }, - "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." - }, - "OriginList":{ - "type":"list", - "member":{ - "shape":"Origin", - "locationName":"Origin" - }, - "min":1 - }, - "OriginProtocolPolicy":{ - "type":"string", - "enum":[ - "http-only", - "match-viewer" - ] - }, - "Origins":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of origins for this distribution." - }, - "Items":{ - "shape":"OriginList", - "documentation":"A complex type that contains origins for this distribution." - } - }, - "documentation":"A complex type that contains information about origins for this distribution." - }, - "PathList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Path" - } - }, - "Paths":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of objects that you want to invalidate." - }, - "Items":{ - "shape":"PathList", - "documentation":"A complex type that contains a list of the objects that you want to invalidate." - } - }, - "documentation":"A complex type that contains information about the objects that you want to invalidate." - }, - "PreconditionFailed":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - "PriceClass":{ - "type":"string", - "enum":[ - "PriceClass_100", - "PriceClass_200", - "PriceClass_All" - ] - }, - "Restrictions":{ - "type":"structure", - "required":["GeoRestriction"], - "members":{ - "GeoRestriction":{"shape":"GeoRestriction"} - }, - "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." - }, - "S3Origin":{ - "type":"structure", - "required":[ - "DomainName", - "OriginAccessIdentity" - ], - "members":{ - "DomainName":{ - "shape":"string", - "documentation":"The DNS name of the S3 origin." - }, - "OriginAccessIdentity":{ - "shape":"string", - "documentation":"Your S3 origin's origin access identity." - } - }, - "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." - }, - "S3OriginConfig":{ - "type":"structure", - "required":["OriginAccessIdentity"], - "members":{ - "OriginAccessIdentity":{ - "shape":"string", - "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." - } - }, - "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." - }, - "SSLSupportMethod":{ - "type":"string", - "enum":[ - "sni-only", - "vip" - ] - }, - "Signer":{ - "type":"structure", - "members":{ - "AwsAccountNumber":{ - "shape":"string", - "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." - }, - "KeyPairIds":{ - "shape":"KeyPairIds", - "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." - } - }, - "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." - }, - "SignerList":{ - "type":"list", - "member":{ - "shape":"Signer", - "locationName":"Signer" - } - }, - "StreamingDistribution":{ - "type":"structure", - "required":[ - "Id", - "Status", - "DomainName", - "ActiveTrustedSigners", - "StreamingDistributionConfig" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." - }, - "Status":{ - "shape":"string", - "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." - }, - "ActiveTrustedSigners":{ - "shape":"ActiveTrustedSigners", - "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." - }, - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The current configuration information for the streaming distribution." - } - }, - "documentation":"A streaming distribution." - }, - "StreamingDistributionAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "StreamingDistributionConfig":{ - "type":"structure", - "required":[ - "CallerReference", - "S3Origin", - "Aliases", - "Comment", - "Logging", - "TrustedSigners", - "PriceClass", - "Enabled" - ], - "members":{ - "CallerReference":{ - "shape":"string", - "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." - }, - "S3Origin":{ - "shape":"S3Origin", - "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." - }, - "Comment":{ - "shape":"string", - "documentation":"Any comments you want to include about the streaming distribution." - }, - "Logging":{ - "shape":"StreamingLoggingConfig", - "documentation":"A complex type that controls whether access logs are written for the streaming distribution." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "PriceClass":{ - "shape":"PriceClass", - "documentation":"A complex type that contains information about price class for this streaming distribution." - }, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." - } - }, - "documentation":"The configuration for the streaming distribution." - }, - "StreamingDistributionList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of streaming distributions that were created by the current AWS account." - }, - "Items":{ - "shape":"StreamingDistributionSummaryList", - "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." - } - }, - "documentation":"A streaming distribution list." - }, - "StreamingDistributionNotDisabled":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "StreamingDistributionSummary":{ - "type":"structure", - "required":[ - "Id", - "Status", - "LastModifiedTime", - "DomainName", - "S3Origin", - "Aliases", - "TrustedSigners", - "Comment", - "PriceClass", - "Enabled" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." - }, - "S3Origin":{ - "shape":"S3Origin", - "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "Comment":{ - "shape":"string", - "documentation":"The comment originally specified when this distribution was created." - }, - "PriceClass":{"shape":"PriceClass"}, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the distribution is enabled to accept end user requests for content." - } - }, - "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." - }, - "StreamingDistributionSummaryList":{ - "type":"list", - "member":{ - "shape":"StreamingDistributionSummary", - "locationName":"StreamingDistributionSummary" - } - }, - "StreamingLoggingConfig":{ - "type":"structure", - "required":[ - "Enabled", - "Bucket", - "Prefix" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." - }, - "Bucket":{ - "shape":"string", - "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." - }, - "Prefix":{ - "shape":"string", - "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." - } - }, - "documentation":"A complex type that controls whether access logs are written for this streaming distribution." - }, - "TooManyCacheBehaviors":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore cache behaviors for the distribution." - }, - "TooManyCertificates":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore custom ssl certificates." - }, - "TooManyCloudFrontOriginAccessIdentities":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." - }, - "TooManyCookieNamesInWhiteList":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." - }, - "TooManyDistributionCNAMEs":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more CNAMEs than are allowed per distribution." - }, - "TooManyDistributions":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." - }, - "TooManyHeadersInForwardedValues":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "TooManyInvalidationsInProgress":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." - }, - "TooManyOrigins":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore origins for the distribution." - }, - "TooManyStreamingDistributionCNAMEs":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "TooManyStreamingDistributions":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." - }, - "TooManyTrustedSigners":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - "TrustedSignerDoesNotExist":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - "TrustedSigners":{ - "type":"structure", - "required":[ - "Enabled", - "Quantity" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of trusted signers for this cache behavior." - }, - "Items":{ - "shape":"AwsAccountNumberList", - "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "UpdateCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "required":[ - "CloudFrontOriginAccessIdentityConfig", - "Id" - ], - "members":{ - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The identity's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"CloudFrontOriginAccessIdentityConfig" - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The identity's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to update an origin access identity.", - "payload":"CloudFrontOriginAccessIdentityConfig" - }, - "UpdateCloudFrontOriginAccessIdentityResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentity":{ - "shape":"CloudFrontOriginAccessIdentity", - "documentation":"The origin access identity's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentity" - }, - "UpdateDistributionRequest":{ - "type":"structure", - "required":[ - "DistributionConfig", - "Id" - ], - "members":{ - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"DistributionConfig" - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to update a distribution.", - "payload":"DistributionConfig" - }, - "UpdateDistributionResult":{ - "type":"structure", - "members":{ - "Distribution":{ - "shape":"Distribution", - "documentation":"The distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Distribution" - }, - "UpdateStreamingDistributionRequest":{ - "type":"structure", - "required":[ - "StreamingDistributionConfig", - "Id" - ], - "members":{ - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The streaming distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, - "locationName":"StreamingDistributionConfig" - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The streaming distribution's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to update a streaming distribution.", - "payload":"StreamingDistributionConfig" - }, - "UpdateStreamingDistributionResult":{ - "type":"structure", - "members":{ - "StreamingDistribution":{ - "shape":"StreamingDistribution", - "documentation":"The streaming distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistribution" - }, - "ViewerCertificate":{ - "type":"structure", - "members":{ - "IAMCertificateId":{ - "shape":"string", - "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." - }, - "CloudFrontDefaultCertificate":{ - "shape":"boolean", - "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." - }, - "SSLSupportMethod":{ - "shape":"SSLSupportMethod", - "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." - } - }, - "documentation":"A complex type that contains information about viewer certificates for this distribution." - }, - "ViewerProtocolPolicy":{ - "type":"string", - "enum":[ - "allow-all", - "https-only", - "redirect-to-https" - ] - }, - "boolean":{"type":"boolean"}, - "integer":{"type":"integer"}, - "long":{"type":"long"}, - "string":{"type":"string"}, - "timestamp":{"type":"timestamp"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.paginators.json deleted file mode 100644 index 51fbb907fa..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.paginators.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "pagination": { - "ListCloudFrontOriginAccessIdentities": { - "input_token": "Marker", - "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", - "limit_key": "MaxItems", - "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", - "result_key": "CloudFrontOriginAccessIdentityList.Items" - }, - "ListDistributions": { - "input_token": "Marker", - "output_token": "DistributionList.NextMarker", - "limit_key": "MaxItems", - "more_results": "DistributionList.IsTruncated", - "result_key": "DistributionList.Items" - }, - "ListInvalidations": { - "input_token": "Marker", - "output_token": "InvalidationList.NextMarker", - "limit_key": "MaxItems", - "more_results": "InvalidationList.IsTruncated", - "result_key": "InvalidationList.Items" - }, - "ListStreamingDistributions": { - "input_token": "Marker", - "output_token": "StreamingDistributionList.NextMarker", - "limit_key": "MaxItems", - "more_results": "StreamingDistributionList.IsTruncated", - "result_key": "StreamingDistributionList.Items" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.waiters.json deleted file mode 100644 index 6e044bc51b..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-05-31.waiters.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "version": 2, - "waiters": { - "DistributionDeployed": { - "delay": 60, - "operation": "GetDistribution", - "maxAttempts": 25, - "description": "Wait until a distribution is deployed.", - "acceptors": [ - { - "expected": "Deployed", - "matcher": "path", - "state": "success", - "argument": "Distribution.Status" - } - ] - }, - "InvalidationCompleted": { - "delay": 20, - "operation": "GetInvalidation", - "maxAttempts": 60, - "description": "Wait until an invalidation has completed.", - "acceptors": [ - { - "expected": "Completed", - "matcher": "path", - "state": "success", - "argument": "Invalidation.Status" - } - ] - }, - "StreamingDistributionDeployed": { - "delay": 60, - "operation": "GetStreamingDistribution", - "maxAttempts": 25, - "description": "Wait until a streaming distribution is deployed.", - "acceptors": [ - { - "expected": "Deployed", - "matcher": "path", - "state": "success", - "argument": "StreamingDistribution.Status" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.normal.json deleted file mode 100644 index 8e7516574a..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.normal.json +++ /dev/null @@ -1,3588 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-10-21", - "endpointPrefix":"cloudfront", - "globalEndpoint":"cloudfront.amazonaws.com", - "serviceAbbreviation":"CloudFront", - "serviceFullName":"Amazon CloudFront", - "signatureVersion":"v4", - "protocol":"rest-xml" - }, - "operations":{ - "CreateCloudFrontOriginAccessIdentity":{ - "name":"CreateCloudFrontOriginAccessIdentity2014_10_21", - "http":{ - "method":"POST", - "requestUri":"/2014-10-21/origin-access-identity/cloudfront", - "responseCode":201 - }, - "input":{ - "shape":"CreateCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to create a new origin access identity." - }, - "output":{ - "shape":"CreateCloudFrontOriginAccessIdentityResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"CloudFrontOriginAccessIdentityAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"TooManyCloudFrontOriginAccessIdentities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Create a new origin access identity." - }, - "CreateDistribution":{ - "name":"CreateDistribution2014_10_21", - "http":{ - "method":"POST", - "requestUri":"/2014-10-21/distribution", - "responseCode":201 - }, - "input":{ - "shape":"CreateDistributionRequest", - "documentation":"The request to create a new distribution." - }, - "output":{ - "shape":"CreateDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"DistributionAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." - }, - { - "shape":"InvalidOrigin", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"InvalidViewerCertificate", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"TooManyDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more CNAMEs than are allowed per distribution." - }, - { - "shape":"TooManyDistributions", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." - }, - { - "shape":"InvalidDefaultRootObject", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The default root object file name is too big or contains an invalid character." - }, - { - "shape":"InvalidRelativePath", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." - }, - { - "shape":"InvalidErrorCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidResponseCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InvalidRequiredProtocol", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." - }, - { - "shape":"NoSuchOrigin", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"No origin exists with the specified Origin Id." - }, - { - "shape":"TooManyOrigins", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore origins for the distribution." - }, - { - "shape":"TooManyCacheBehaviors", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore cache behaviors for the distribution." - }, - { - "shape":"TooManyCookieNamesInWhiteList", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." - }, - { - "shape":"InvalidForwardCookies", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." - }, - { - "shape":"TooManyHeadersInForwardedValues", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidHeadersForS3Origin", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - }, - { - "shape":"TooManyCertificates", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore custom ssl certificates." - }, - { - "shape":"InvalidLocationCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidGeoRestrictionParameter", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidProtocolSettings", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." - } - ], - "documentation":"Create a new distribution." - }, - "CreateInvalidation":{ - "name":"CreateInvalidation2014_10_21", - "http":{ - "method":"POST", - "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation", - "responseCode":201 - }, - "input":{ - "shape":"CreateInvalidationRequest", - "documentation":"The request to create an invalidation." - }, - "output":{ - "shape":"CreateInvalidationResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"BatchTooLarge", - "error":{"httpStatusCode":413}, - "exception":true - }, - { - "shape":"TooManyInvalidationsInProgress", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Create a new invalidation." - }, - "CreateStreamingDistribution":{ - "name":"CreateStreamingDistribution2014_10_21", - "http":{ - "method":"POST", - "requestUri":"/2014-10-21/streaming-distribution", - "responseCode":201 - }, - "input":{ - "shape":"CreateStreamingDistributionRequest", - "documentation":"The request to create a new streaming distribution." - }, - "output":{ - "shape":"CreateStreamingDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"StreamingDistributionAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"InvalidOrigin", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"TooManyStreamingDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"TooManyStreamingDistributions", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Create a new streaming distribution." - }, - "DeleteCloudFrontOriginAccessIdentity":{ - "name":"DeleteCloudFrontOriginAccessIdentity2014_10_21", - "http":{ - "method":"DELETE", - "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to delete a origin access identity." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"CloudFrontOriginAccessIdentityInUse", - "error":{"httpStatusCode":409}, - "exception":true - } - ], - "documentation":"Delete an origin access identity." - }, - "DeleteDistribution":{ - "name":"DeleteDistribution2014_10_21", - "http":{ - "method":"DELETE", - "requestUri":"/2014-10-21/distribution/{Id}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteDistributionRequest", - "documentation":"The request to delete a distribution." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"DistributionNotDisabled", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - } - ], - "documentation":"Delete a distribution." - }, - "DeleteStreamingDistribution":{ - "name":"DeleteStreamingDistribution2014_10_21", - "http":{ - "method":"DELETE", - "requestUri":"/2014-10-21/streaming-distribution/{Id}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteStreamingDistributionRequest", - "documentation":"The request to delete a streaming distribution." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"StreamingDistributionNotDisabled", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - } - ], - "documentation":"Delete a streaming distribution." - }, - "GetCloudFrontOriginAccessIdentity":{ - "name":"GetCloudFrontOriginAccessIdentity2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}" - }, - "input":{ - "shape":"GetCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to get an origin access identity's information." - }, - "output":{ - "shape":"GetCloudFrontOriginAccessIdentityResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about an origin access identity." - }, - "GetCloudFrontOriginAccessIdentityConfig":{ - "name":"GetCloudFrontOriginAccessIdentityConfig2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}/config" - }, - "input":{ - "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", - "documentation":"The request to get an origin access identity's configuration." - }, - "output":{ - "shape":"GetCloudFrontOriginAccessIdentityConfigResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the configuration information about an origin access identity." - }, - "GetDistribution":{ - "name":"GetDistribution2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/distribution/{Id}" - }, - "input":{ - "shape":"GetDistributionRequest", - "documentation":"The request to get a distribution's information." - }, - "output":{ - "shape":"GetDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about a distribution." - }, - "GetDistributionConfig":{ - "name":"GetDistributionConfig2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/distribution/{Id}/config" - }, - "input":{ - "shape":"GetDistributionConfigRequest", - "documentation":"The request to get a distribution configuration." - }, - "output":{ - "shape":"GetDistributionConfigResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the configuration information about a distribution." - }, - "GetInvalidation":{ - "name":"GetInvalidation2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation/{Id}" - }, - "input":{ - "shape":"GetInvalidationRequest", - "documentation":"The request to get an invalidation's information." - }, - "output":{ - "shape":"GetInvalidationResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchInvalidation", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified invalidation does not exist." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about an invalidation." - }, - "GetStreamingDistribution":{ - "name":"GetStreamingDistribution2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/streaming-distribution/{Id}" - }, - "input":{ - "shape":"GetStreamingDistributionRequest", - "documentation":"The request to get a streaming distribution's information." - }, - "output":{ - "shape":"GetStreamingDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the information about a streaming distribution." - }, - "GetStreamingDistributionConfig":{ - "name":"GetStreamingDistributionConfig2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/streaming-distribution/{Id}/config" - }, - "input":{ - "shape":"GetStreamingDistributionConfigRequest", - "documentation":"To request to get a streaming distribution configuration." - }, - "output":{ - "shape":"GetStreamingDistributionConfigResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"Get the configuration information about a streaming distribution." - }, - "ListCloudFrontOriginAccessIdentities":{ - "name":"ListCloudFrontOriginAccessIdentities2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/origin-access-identity/cloudfront" - }, - "input":{ - "shape":"ListCloudFrontOriginAccessIdentitiesRequest", - "documentation":"The request to list origin access identities." - }, - "output":{ - "shape":"ListCloudFrontOriginAccessIdentitiesResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - } - ], - "documentation":"List origin access identities." - }, - "ListDistributions":{ - "name":"ListDistributions2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/distribution" - }, - "input":{ - "shape":"ListDistributionsRequest", - "documentation":"The request to list your distributions." - }, - "output":{ - "shape":"ListDistributionsResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - } - ], - "documentation":"List distributions." - }, - "ListInvalidations":{ - "name":"ListInvalidations2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation" - }, - "input":{ - "shape":"ListInvalidationsRequest", - "documentation":"The request to list invalidations." - }, - "output":{ - "shape":"ListInvalidationsResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - } - ], - "documentation":"List invalidation batches." - }, - "ListStreamingDistributions":{ - "name":"ListStreamingDistributions2014_10_21", - "http":{ - "method":"GET", - "requestUri":"/2014-10-21/streaming-distribution" - }, - "input":{ - "shape":"ListStreamingDistributionsRequest", - "documentation":"The request to list your streaming distributions." - }, - "output":{ - "shape":"ListStreamingDistributionsResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - } - ], - "documentation":"List streaming distributions." - }, - "UpdateCloudFrontOriginAccessIdentity":{ - "name":"UpdateCloudFrontOriginAccessIdentity2014_10_21", - "http":{ - "method":"PUT", - "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}/config" - }, - "input":{ - "shape":"UpdateCloudFrontOriginAccessIdentityRequest", - "documentation":"The request to update an origin access identity." - }, - "output":{ - "shape":"UpdateCloudFrontOriginAccessIdentityResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"IllegalUpdate", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"NoSuchCloudFrontOriginAccessIdentity", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Update an origin access identity." - }, - "UpdateDistribution":{ - "name":"UpdateDistribution2014_10_21", - "http":{ - "method":"PUT", - "requestUri":"/2014-10-21/distribution/{Id}/config" - }, - "input":{ - "shape":"UpdateDistributionRequest", - "documentation":"The request to update a distribution." - }, - "output":{ - "shape":"UpdateDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"IllegalUpdate", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"NoSuchDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"TooManyDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more CNAMEs than are allowed per distribution." - }, - { - "shape":"InvalidDefaultRootObject", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The default root object file name is too big or contains an invalid character." - }, - { - "shape":"InvalidRelativePath", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." - }, - { - "shape":"InvalidErrorCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidResponseCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"InvalidViewerCertificate", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidRequiredProtocol", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." - }, - { - "shape":"NoSuchOrigin", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"No origin exists with the specified Origin Id." - }, - { - "shape":"TooManyOrigins", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore origins for the distribution." - }, - { - "shape":"TooManyCacheBehaviors", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore cache behaviors for the distribution." - }, - { - "shape":"TooManyCookieNamesInWhiteList", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." - }, - { - "shape":"InvalidForwardCookies", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." - }, - { - "shape":"TooManyHeadersInForwardedValues", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidHeadersForS3Origin", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - }, - { - "shape":"TooManyCertificates", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore custom ssl certificates." - }, - { - "shape":"InvalidLocationCode", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidGeoRestrictionParameter", - "error":{"httpStatusCode":400}, - "exception":true - } - ], - "documentation":"Update a distribution." - }, - "UpdateStreamingDistribution":{ - "name":"UpdateStreamingDistribution2014_10_21", - "http":{ - "method":"PUT", - "requestUri":"/2014-10-21/streaming-distribution/{Id}/config" - }, - "input":{ - "shape":"UpdateStreamingDistributionRequest", - "documentation":"The request to update a streaming distribution." - }, - "output":{ - "shape":"UpdateStreamingDistributionResult", - "documentation":"The returned result of the corresponding request." - }, - "errors":[ - { - "shape":"AccessDenied", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - { - "shape":"CNAMEAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true - }, - { - "shape":"IllegalUpdate", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - { - "shape":"InvalidIfMatchVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - { - "shape":"MissingBody", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - { - "shape":"NoSuchStreamingDistribution", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - { - "shape":"PreconditionFailed", - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - { - "shape":"TooManyStreamingDistributionCNAMEs", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidArgument", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - { - "shape":"InvalidOriginAccessIdentity", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - { - "shape":"TooManyTrustedSigners", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - { - "shape":"TrustedSignerDoesNotExist", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - { - "shape":"InconsistentQuantities", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - } - ], - "documentation":"Update a streaming distribution." - } - }, - "shapes":{ - "AccessDenied":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Access denied." - }, - "ActiveTrustedSigners":{ - "type":"structure", - "required":[ - "Enabled", - "Quantity" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Each active trusted signer." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." - }, - "Items":{ - "shape":"SignerList", - "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." - } - }, - "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." - }, - "AliasList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"CNAME" - } - }, - "Aliases":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of CNAMEs, if any, for this distribution." - }, - "Items":{ - "shape":"AliasList", - "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." - }, - "AllowedMethods":{ - "type":"structure", - "required":[ - "Quantity", - "Items" - ], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." - }, - "Items":{ - "shape":"MethodsList", - "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." - }, - "CachedMethods":{"shape":"CachedMethods"} - }, - "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." - }, - "AwsAccountNumberList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"AwsAccountNumber" - } - }, - "BatchTooLarge":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":413}, - "exception":true - }, - "CNAMEAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "CacheBehavior":{ - "type":"structure", - "required":[ - "PathPattern", - "TargetOriginId", - "ForwardedValues", - "TrustedSigners", - "ViewerProtocolPolicy", - "MinTTL" - ], - "members":{ - "PathPattern":{ - "shape":"string", - "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." - }, - "TargetOriginId":{ - "shape":"string", - "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." - }, - "ForwardedValues":{ - "shape":"ForwardedValues", - "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "ViewerProtocolPolicy":{ - "shape":"ViewerProtocolPolicy", - "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." - }, - "MinTTL":{ - "shape":"long", - "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." - }, - "AllowedMethods":{"shape":"AllowedMethods"}, - "SmoothStreaming":{ - "shape":"boolean", - "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." - } - }, - "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." - }, - "CacheBehaviorList":{ - "type":"list", - "member":{ - "shape":"CacheBehavior", - "locationName":"CacheBehavior" - } - }, - "CacheBehaviors":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of cache behaviors for this distribution." - }, - "Items":{ - "shape":"CacheBehaviorList", - "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that contains zero or more CacheBehavior elements." - }, - "CachedMethods":{ - "type":"structure", - "required":[ - "Quantity", - "Items" - ], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." - }, - "Items":{ - "shape":"MethodsList", - "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." - } - }, - "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." - }, - "CloudFrontOriginAccessIdentity":{ - "type":"structure", - "required":[ - "Id", - "S3CanonicalUserId" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." - }, - "S3CanonicalUserId":{ - "shape":"string", - "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." - }, - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The current configuration information for the identity." - } - }, - "documentation":"CloudFront origin access identity." - }, - "CloudFrontOriginAccessIdentityAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." - }, - "CloudFrontOriginAccessIdentityConfig":{ - "type":"structure", - "required":[ - "CallerReference", - "Comment" - ], - "members":{ - "CallerReference":{ - "shape":"string", - "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." - }, - "Comment":{ - "shape":"string", - "documentation":"Any comments you want to include about the origin access identity." - } - }, - "documentation":"Origin access identity configuration." - }, - "CloudFrontOriginAccessIdentityInUse":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "CloudFrontOriginAccessIdentityList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." - }, - "Items":{ - "shape":"CloudFrontOriginAccessIdentitySummaryList", - "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." - } - }, - "documentation":"The CloudFrontOriginAccessIdentityList type." - }, - "CloudFrontOriginAccessIdentitySummary":{ - "type":"structure", - "required":[ - "Id", - "S3CanonicalUserId", - "Comment" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." - }, - "S3CanonicalUserId":{ - "shape":"string", - "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." - }, - "Comment":{ - "shape":"string", - "documentation":"The comment for this origin access identity, as originally specified when created." - } - }, - "documentation":"Summary of the information about a CloudFront origin access identity." - }, - "CloudFrontOriginAccessIdentitySummaryList":{ - "type":"list", - "member":{ - "shape":"CloudFrontOriginAccessIdentitySummary", - "locationName":"CloudFrontOriginAccessIdentitySummary" - } - }, - "CookieNameList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Name" - } - }, - "CookieNames":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of whitelisted cookies for this cache behavior." - }, - "Items":{ - "shape":"CookieNameList", - "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." - }, - "CookiePreference":{ - "type":"structure", - "required":["Forward"], - "members":{ - "Forward":{ - "shape":"ItemSelection", - "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." - }, - "WhitelistedNames":{ - "shape":"CookieNames", - "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." - } - }, - "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." - }, - "CreateCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "required":["CloudFrontOriginAccessIdentityConfig"], - "members":{ - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The origin access identity's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"CloudFrontOriginAccessIdentityConfig" - } - }, - "documentation":"The request to create a new origin access identity.", - "payload":"CloudFrontOriginAccessIdentityConfig" - }, - "CreateCloudFrontOriginAccessIdentityResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentity":{ - "shape":"CloudFrontOriginAccessIdentity", - "documentation":"The origin access identity's information." - }, - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the origin access identity created." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentity" - }, - "CreateDistributionRequest":{ - "type":"structure", - "required":["DistributionConfig"], - "members":{ - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"DistributionConfig" - } - }, - "documentation":"The request to create a new distribution.", - "payload":"DistributionConfig" - }, - "CreateDistributionResult":{ - "type":"structure", - "members":{ - "Distribution":{ - "shape":"Distribution", - "documentation":"The distribution's information." - }, - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the distribution created." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Distribution" - }, - "CreateInvalidationRequest":{ - "type":"structure", - "required":[ - "DistributionId", - "InvalidationBatch" - ], - "members":{ - "DistributionId":{ - "shape":"string", - "location":"uri", - "locationName":"DistributionId", - "documentation":"The distribution's id." - }, - "InvalidationBatch":{ - "shape":"InvalidationBatch", - "documentation":"The batch information for the invalidation.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"InvalidationBatch" - } - }, - "documentation":"The request to create an invalidation.", - "payload":"InvalidationBatch" - }, - "CreateInvalidationResult":{ - "type":"structure", - "members":{ - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." - }, - "Invalidation":{ - "shape":"Invalidation", - "documentation":"The invalidation's information." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Invalidation" - }, - "CreateStreamingDistributionRequest":{ - "type":"structure", - "required":["StreamingDistributionConfig"], - "members":{ - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The streaming distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"StreamingDistributionConfig" - } - }, - "documentation":"The request to create a new streaming distribution.", - "payload":"StreamingDistributionConfig" - }, - "CreateStreamingDistributionResult":{ - "type":"structure", - "members":{ - "StreamingDistribution":{ - "shape":"StreamingDistribution", - "documentation":"The streaming distribution's information." - }, - "Location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the streaming distribution created." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistribution" - }, - "CustomErrorResponse":{ - "type":"structure", - "required":["ErrorCode"], - "members":{ - "ErrorCode":{ - "shape":"integer", - "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." - }, - "ResponsePagePath":{ - "shape":"string", - "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." - }, - "ResponseCode":{ - "shape":"string", - "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." - }, - "ErrorCachingMinTTL":{ - "shape":"long", - "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." - } - }, - "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." - }, - "CustomErrorResponseList":{ - "type":"list", - "member":{ - "shape":"CustomErrorResponse", - "locationName":"CustomErrorResponse" - } - }, - "CustomErrorResponses":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of custom error responses for this distribution." - }, - "Items":{ - "shape":"CustomErrorResponseList", - "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that contains zero or more CustomErrorResponse elements." - }, - "CustomOriginConfig":{ - "type":"structure", - "required":[ - "HTTPPort", - "HTTPSPort", - "OriginProtocolPolicy" - ], - "members":{ - "HTTPPort":{ - "shape":"integer", - "documentation":"The HTTP port the custom origin listens on." - }, - "HTTPSPort":{ - "shape":"integer", - "documentation":"The HTTPS port the custom origin listens on." - }, - "OriginProtocolPolicy":{ - "shape":"OriginProtocolPolicy", - "documentation":"The origin protocol policy to apply to your origin." - } - }, - "documentation":"A customer origin." - }, - "DefaultCacheBehavior":{ - "type":"structure", - "required":[ - "TargetOriginId", - "ForwardedValues", - "TrustedSigners", - "ViewerProtocolPolicy", - "MinTTL" - ], - "members":{ - "TargetOriginId":{ - "shape":"string", - "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." - }, - "ForwardedValues":{ - "shape":"ForwardedValues", - "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "ViewerProtocolPolicy":{ - "shape":"ViewerProtocolPolicy", - "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." - }, - "MinTTL":{ - "shape":"long", - "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." - }, - "AllowedMethods":{"shape":"AllowedMethods"}, - "SmoothStreaming":{ - "shape":"boolean", - "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." - } - }, - "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." - }, - "DeleteCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The origin access identity's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to delete a origin access identity.", - "required":["Id"] - }, - "DeleteDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to delete a distribution.", - "required":["Id"] - }, - "DeleteStreamingDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to delete a streaming distribution.", - "required":["Id"] - }, - "Distribution":{ - "type":"structure", - "required":[ - "Id", - "Status", - "LastModifiedTime", - "InProgressInvalidationBatches", - "DomainName", - "ActiveTrustedSigners", - "DistributionConfig" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "InProgressInvalidationBatches":{ - "shape":"integer", - "documentation":"The number of invalidation batches currently in progress." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." - }, - "ActiveTrustedSigners":{ - "shape":"ActiveTrustedSigners", - "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." - }, - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The current configuration information for the distribution." - } - }, - "documentation":"A distribution." - }, - "DistributionAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." - }, - "DistributionConfig":{ - "type":"structure", - "required":[ - "CallerReference", - "Aliases", - "DefaultRootObject", - "Origins", - "DefaultCacheBehavior", - "CacheBehaviors", - "Comment", - "Logging", - "PriceClass", - "Enabled" - ], - "members":{ - "CallerReference":{ - "shape":"string", - "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." - }, - "DefaultRootObject":{ - "shape":"string", - "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." - }, - "Origins":{ - "shape":"Origins", - "documentation":"A complex type that contains information about origins for this distribution." - }, - "DefaultCacheBehavior":{ - "shape":"DefaultCacheBehavior", - "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." - }, - "CacheBehaviors":{ - "shape":"CacheBehaviors", - "documentation":"A complex type that contains zero or more CacheBehavior elements." - }, - "CustomErrorResponses":{ - "shape":"CustomErrorResponses", - "documentation":"A complex type that contains zero or more CustomErrorResponse elements." - }, - "Comment":{ - "shape":"string", - "documentation":"Any comments you want to include about the distribution." - }, - "Logging":{ - "shape":"LoggingConfig", - "documentation":"A complex type that controls whether access logs are written for the distribution." - }, - "PriceClass":{ - "shape":"PriceClass", - "documentation":"A complex type that contains information about price class for this distribution." - }, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the distribution is enabled to accept end user requests for content." - }, - "ViewerCertificate":{"shape":"ViewerCertificate"}, - "Restrictions":{"shape":"Restrictions"} - }, - "documentation":"A distribution Configuration." - }, - "DistributionList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of distributions that were created by the current AWS account." - }, - "Items":{ - "shape":"DistributionSummaryList", - "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." - } - }, - "documentation":"A distribution list." - }, - "DistributionNotDisabled":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "DistributionSummary":{ - "type":"structure", - "required":[ - "Id", - "Status", - "LastModifiedTime", - "DomainName", - "Aliases", - "Origins", - "DefaultCacheBehavior", - "CacheBehaviors", - "CustomErrorResponses", - "Comment", - "PriceClass", - "Enabled", - "ViewerCertificate", - "Restrictions" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." - }, - "Origins":{ - "shape":"Origins", - "documentation":"A complex type that contains information about origins for this distribution." - }, - "DefaultCacheBehavior":{ - "shape":"DefaultCacheBehavior", - "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." - }, - "CacheBehaviors":{ - "shape":"CacheBehaviors", - "documentation":"A complex type that contains zero or more CacheBehavior elements." - }, - "CustomErrorResponses":{ - "shape":"CustomErrorResponses", - "documentation":"A complex type that contains zero or more CustomErrorResponses elements." - }, - "Comment":{ - "shape":"string", - "documentation":"The comment originally specified when this distribution was created." - }, - "PriceClass":{"shape":"PriceClass"}, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the distribution is enabled to accept end user requests for content." - }, - "ViewerCertificate":{"shape":"ViewerCertificate"}, - "Restrictions":{"shape":"Restrictions"} - }, - "documentation":"A summary of the information for an Amazon CloudFront distribution." - }, - "DistributionSummaryList":{ - "type":"list", - "member":{ - "shape":"DistributionSummary", - "locationName":"DistributionSummary" - } - }, - "ForwardedValues":{ - "type":"structure", - "required":[ - "QueryString", - "Cookies" - ], - "members":{ - "QueryString":{ - "shape":"boolean", - "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." - }, - "Cookies":{ - "shape":"CookiePreference", - "documentation":"A complex type that specifies how CloudFront handles cookies." - }, - "Headers":{ - "shape":"Headers", - "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." - } - }, - "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." - }, - "GeoRestriction":{ - "type":"structure", - "required":[ - "RestrictionType", - "Quantity" - ], - "members":{ - "RestrictionType":{ - "shape":"GeoRestrictionType", - "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." - }, - "Quantity":{ - "shape":"integer", - "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." - }, - "Items":{ - "shape":"LocationList", - "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." - } - }, - "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." - }, - "GeoRestrictionType":{ - "type":"string", - "enum":[ - "blacklist", - "whitelist", - "none" - ] - }, - "GetCloudFrontOriginAccessIdentityConfigRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The identity's id." - } - }, - "documentation":"The request to get an origin access identity's configuration.", - "required":["Id"] - }, - "GetCloudFrontOriginAccessIdentityConfigResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The origin access identity's configuration information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentityConfig" - }, - "GetCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The identity's id." - } - }, - "documentation":"The request to get an origin access identity's information.", - "required":["Id"] - }, - "GetCloudFrontOriginAccessIdentityResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentity":{ - "shape":"CloudFrontOriginAccessIdentity", - "documentation":"The origin access identity's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentity" - }, - "GetDistributionConfigRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution's id." - } - }, - "documentation":"The request to get a distribution configuration.", - "required":["Id"] - }, - "GetDistributionConfigResult":{ - "type":"structure", - "members":{ - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The distribution's configuration information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"DistributionConfig" - }, - "GetDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution's id." - } - }, - "documentation":"The request to get a distribution's information.", - "required":["Id"] - }, - "GetDistributionResult":{ - "type":"structure", - "members":{ - "Distribution":{ - "shape":"Distribution", - "documentation":"The distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Distribution" - }, - "GetInvalidationRequest":{ - "type":"structure", - "required":[ - "DistributionId", - "Id" - ], - "members":{ - "DistributionId":{ - "shape":"string", - "location":"uri", - "locationName":"DistributionId", - "documentation":"The distribution's id." - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The invalidation's id." - } - }, - "documentation":"The request to get an invalidation's information." - }, - "GetInvalidationResult":{ - "type":"structure", - "members":{ - "Invalidation":{ - "shape":"Invalidation", - "documentation":"The invalidation's information." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Invalidation" - }, - "GetStreamingDistributionConfigRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The streaming distribution's id." - } - }, - "documentation":"To request to get a streaming distribution configuration.", - "required":["Id"] - }, - "GetStreamingDistributionConfigResult":{ - "type":"structure", - "members":{ - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The streaming distribution's configuration information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistributionConfig" - }, - "GetStreamingDistributionRequest":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The streaming distribution's id." - } - }, - "documentation":"The request to get a streaming distribution's information.", - "required":["Id"] - }, - "GetStreamingDistributionResult":{ - "type":"structure", - "members":{ - "StreamingDistribution":{ - "shape":"StreamingDistribution", - "documentation":"The streaming distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistribution" - }, - "HeaderList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Name" - } - }, - "Headers":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." - }, - "Items":{ - "shape":"HeaderList", - "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." - } - }, - "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." - }, - "IllegalUpdate":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Origin and CallerReference cannot be updated." - }, - "InconsistentQuantities":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The value of Quantity and the size of Items do not match." - }, - "InvalidArgument":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The argument is invalid." - }, - "InvalidDefaultRootObject":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The default root object file name is too big or contains an invalid character." - }, - "InvalidErrorCode":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidForwardCookies":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." - }, - "InvalidGeoRestrictionParameter":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidHeadersForS3Origin":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidIfMatchVersion":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The If-Match version is missing or not valid for the distribution." - }, - "InvalidLocationCode":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidOrigin":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." - }, - "InvalidOriginAccessIdentity":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The origin access identity is not valid or doesn't exist." - }, - "InvalidProtocolSettings":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." - }, - "InvalidRelativePath":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." - }, - "InvalidRequiredProtocol":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." - }, - "InvalidResponseCode":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "InvalidViewerCertificate":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "Invalidation":{ - "type":"structure", - "required":[ - "Id", - "Status", - "CreateTime", - "InvalidationBatch" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." - }, - "CreateTime":{ - "shape":"timestamp", - "documentation":"The date and time the invalidation request was first made." - }, - "InvalidationBatch":{ - "shape":"InvalidationBatch", - "documentation":"The current invalidation information for the batch request." - } - }, - "documentation":"An invalidation." - }, - "InvalidationBatch":{ - "type":"structure", - "required":[ - "Paths", - "CallerReference" - ], - "members":{ - "Paths":{ - "shape":"Paths", - "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." - }, - "CallerReference":{ - "shape":"string", - "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." - } - }, - "documentation":"An invalidation batch." - }, - "InvalidationList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of invalidation batches that were created by the current AWS account." - }, - "Items":{ - "shape":"InvalidationSummaryList", - "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." - } - }, - "documentation":"An invalidation list." - }, - "InvalidationSummary":{ - "type":"structure", - "required":[ - "Id", - "CreateTime", - "Status" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The unique ID for an invalidation request." - }, - "CreateTime":{"shape":"timestamp"}, - "Status":{ - "shape":"string", - "documentation":"The status of an invalidation request." - } - }, - "documentation":"Summary of an invalidation request." - }, - "InvalidationSummaryList":{ - "type":"list", - "member":{ - "shape":"InvalidationSummary", - "locationName":"InvalidationSummary" - } - }, - "ItemSelection":{ - "type":"string", - "enum":[ - "none", - "whitelist", - "all" - ] - }, - "KeyPairIdList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"KeyPairId" - } - }, - "KeyPairIds":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." - }, - "Items":{ - "shape":"KeyPairIdList", - "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." - } - }, - "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." - }, - "ListCloudFrontOriginAccessIdentitiesRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of origin access identities you want in the response body." - } - }, - "documentation":"The request to list origin access identities." - }, - "ListCloudFrontOriginAccessIdentitiesResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentityList":{ - "shape":"CloudFrontOriginAccessIdentityList", - "documentation":"The CloudFrontOriginAccessIdentityList type." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentityList" - }, - "ListDistributionsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of distributions you want in the response body." - } - }, - "documentation":"The request to list your distributions." - }, - "ListDistributionsResult":{ - "type":"structure", - "members":{ - "DistributionList":{ - "shape":"DistributionList", - "documentation":"The DistributionList type." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"DistributionList" - }, - "ListInvalidationsRequest":{ - "type":"structure", - "required":["DistributionId"], - "members":{ - "DistributionId":{ - "shape":"string", - "location":"uri", - "locationName":"DistributionId", - "documentation":"The distribution's id." - }, - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of invalidation batches you want in the response body." - } - }, - "documentation":"The request to list invalidations." - }, - "ListInvalidationsResult":{ - "type":"structure", - "members":{ - "InvalidationList":{ - "shape":"InvalidationList", - "documentation":"Information about invalidation batches." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"InvalidationList" - }, - "ListStreamingDistributionsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"string", - "location":"querystring", - "locationName":"Marker", - "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." - }, - "MaxItems":{ - "shape":"string", - "location":"querystring", - "locationName":"MaxItems", - "documentation":"The maximum number of streaming distributions you want in the response body." - } - }, - "documentation":"The request to list your streaming distributions." - }, - "ListStreamingDistributionsResult":{ - "type":"structure", - "members":{ - "StreamingDistributionList":{ - "shape":"StreamingDistributionList", - "documentation":"The StreamingDistributionList type." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistributionList" - }, - "LocationList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Location" - } - }, - "LoggingConfig":{ - "type":"structure", - "required":[ - "Enabled", - "IncludeCookies", - "Bucket", - "Prefix" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." - }, - "IncludeCookies":{ - "shape":"boolean", - "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." - }, - "Bucket":{ - "shape":"string", - "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." - }, - "Prefix":{ - "shape":"string", - "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." - } - }, - "documentation":"A complex type that controls whether access logs are written for the distribution." - }, - "Method":{ - "type":"string", - "enum":[ - "GET", - "HEAD", - "POST", - "PUT", - "PATCH", - "OPTIONS", - "DELETE" - ] - }, - "MethodsList":{ - "type":"list", - "member":{ - "shape":"Method", - "locationName":"Method" - } - }, - "MinimumProtocolVersion":{ - "type":"string", - "enum":[ - "SSLv3", - "TLSv1" - ] - }, - "MissingBody":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." - }, - "NoSuchCloudFrontOriginAccessIdentity":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified origin access identity does not exist." - }, - "NoSuchDistribution":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified distribution does not exist." - }, - "NoSuchInvalidation":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified invalidation does not exist." - }, - "NoSuchOrigin":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"No origin exists with the specified Origin Id." - }, - "NoSuchStreamingDistribution":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The specified streaming distribution does not exist." - }, - "Origin":{ - "type":"structure", - "required":[ - "Id", - "DomainName" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." - }, - "DomainName":{ - "shape":"string", - "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." - }, - "S3OriginConfig":{ - "shape":"S3OriginConfig", - "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." - }, - "CustomOriginConfig":{ - "shape":"CustomOriginConfig", - "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." - } - }, - "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." - }, - "OriginList":{ - "type":"list", - "member":{ - "shape":"Origin", - "locationName":"Origin" - }, - "min":1 - }, - "OriginProtocolPolicy":{ - "type":"string", - "enum":[ - "http-only", - "match-viewer" - ] - }, - "Origins":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of origins for this distribution." - }, - "Items":{ - "shape":"OriginList", - "documentation":"A complex type that contains origins for this distribution." - } - }, - "documentation":"A complex type that contains information about origins for this distribution." - }, - "PathList":{ - "type":"list", - "member":{ - "shape":"string", - "locationName":"Path" - } - }, - "Paths":{ - "type":"structure", - "required":["Quantity"], - "members":{ - "Quantity":{ - "shape":"integer", - "documentation":"The number of objects that you want to invalidate." - }, - "Items":{ - "shape":"PathList", - "documentation":"A complex type that contains a list of the objects that you want to invalidate." - } - }, - "documentation":"A complex type that contains information about the objects that you want to invalidate." - }, - "PreconditionFailed":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":412}, - "exception":true, - "documentation":"The precondition given in one or more of the request-header fields evaluated to false." - }, - "PriceClass":{ - "type":"string", - "enum":[ - "PriceClass_100", - "PriceClass_200", - "PriceClass_All" - ] - }, - "Restrictions":{ - "type":"structure", - "required":["GeoRestriction"], - "members":{ - "GeoRestriction":{"shape":"GeoRestriction"} - }, - "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." - }, - "S3Origin":{ - "type":"structure", - "required":[ - "DomainName", - "OriginAccessIdentity" - ], - "members":{ - "DomainName":{ - "shape":"string", - "documentation":"The DNS name of the S3 origin." - }, - "OriginAccessIdentity":{ - "shape":"string", - "documentation":"Your S3 origin's origin access identity." - } - }, - "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." - }, - "S3OriginConfig":{ - "type":"structure", - "required":["OriginAccessIdentity"], - "members":{ - "OriginAccessIdentity":{ - "shape":"string", - "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." - } - }, - "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." - }, - "SSLSupportMethod":{ - "type":"string", - "enum":[ - "sni-only", - "vip" - ] - }, - "Signer":{ - "type":"structure", - "members":{ - "AwsAccountNumber":{ - "shape":"string", - "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." - }, - "KeyPairIds":{ - "shape":"KeyPairIds", - "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." - } - }, - "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." - }, - "SignerList":{ - "type":"list", - "member":{ - "shape":"Signer", - "locationName":"Signer" - } - }, - "StreamingDistribution":{ - "type":"structure", - "required":[ - "Id", - "Status", - "DomainName", - "ActiveTrustedSigners", - "StreamingDistributionConfig" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." - }, - "Status":{ - "shape":"string", - "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." - }, - "ActiveTrustedSigners":{ - "shape":"ActiveTrustedSigners", - "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." - }, - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The current configuration information for the streaming distribution." - } - }, - "documentation":"A streaming distribution." - }, - "StreamingDistributionAlreadyExists":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "StreamingDistributionConfig":{ - "type":"structure", - "required":[ - "CallerReference", - "S3Origin", - "Aliases", - "Comment", - "Logging", - "TrustedSigners", - "PriceClass", - "Enabled" - ], - "members":{ - "CallerReference":{ - "shape":"string", - "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." - }, - "S3Origin":{ - "shape":"S3Origin", - "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." - }, - "Comment":{ - "shape":"string", - "documentation":"Any comments you want to include about the streaming distribution." - }, - "Logging":{ - "shape":"StreamingLoggingConfig", - "documentation":"A complex type that controls whether access logs are written for the streaming distribution." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "PriceClass":{ - "shape":"PriceClass", - "documentation":"A complex type that contains information about price class for this streaming distribution." - }, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." - } - }, - "documentation":"The configuration for the streaming distribution." - }, - "StreamingDistributionList":{ - "type":"structure", - "required":[ - "Marker", - "MaxItems", - "IsTruncated", - "Quantity" - ], - "members":{ - "Marker":{ - "shape":"string", - "documentation":"The value you provided for the Marker request parameter." - }, - "NextMarker":{ - "shape":"string", - "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." - }, - "MaxItems":{ - "shape":"integer", - "documentation":"The value you provided for the MaxItems request parameter." - }, - "IsTruncated":{ - "shape":"boolean", - "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of streaming distributions that were created by the current AWS account." - }, - "Items":{ - "shape":"StreamingDistributionSummaryList", - "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." - } - }, - "documentation":"A streaming distribution list." - }, - "StreamingDistributionNotDisabled":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "StreamingDistributionSummary":{ - "type":"structure", - "required":[ - "Id", - "Status", - "LastModifiedTime", - "DomainName", - "S3Origin", - "Aliases", - "TrustedSigners", - "Comment", - "PriceClass", - "Enabled" - ], - "members":{ - "Id":{ - "shape":"string", - "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." - }, - "Status":{ - "shape":"string", - "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." - }, - "LastModifiedTime":{ - "shape":"timestamp", - "documentation":"The date and time the distribution was last modified." - }, - "DomainName":{ - "shape":"string", - "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." - }, - "S3Origin":{ - "shape":"S3Origin", - "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." - }, - "Aliases":{ - "shape":"Aliases", - "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." - }, - "TrustedSigners":{ - "shape":"TrustedSigners", - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "Comment":{ - "shape":"string", - "documentation":"The comment originally specified when this distribution was created." - }, - "PriceClass":{"shape":"PriceClass"}, - "Enabled":{ - "shape":"boolean", - "documentation":"Whether the distribution is enabled to accept end user requests for content." - } - }, - "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." - }, - "StreamingDistributionSummaryList":{ - "type":"list", - "member":{ - "shape":"StreamingDistributionSummary", - "locationName":"StreamingDistributionSummary" - } - }, - "StreamingLoggingConfig":{ - "type":"structure", - "required":[ - "Enabled", - "Bucket", - "Prefix" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." - }, - "Bucket":{ - "shape":"string", - "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." - }, - "Prefix":{ - "shape":"string", - "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." - } - }, - "documentation":"A complex type that controls whether access logs are written for this streaming distribution." - }, - "TooManyCacheBehaviors":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore cache behaviors for the distribution." - }, - "TooManyCertificates":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore custom ssl certificates." - }, - "TooManyCloudFrontOriginAccessIdentities":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." - }, - "TooManyCookieNamesInWhiteList":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." - }, - "TooManyDistributionCNAMEs":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more CNAMEs than are allowed per distribution." - }, - "TooManyDistributions":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." - }, - "TooManyHeadersInForwardedValues":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "TooManyInvalidationsInProgress":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." - }, - "TooManyOrigins":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"You cannot create anymore origins for the distribution." - }, - "TooManyStreamingDistributionCNAMEs":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "TooManyStreamingDistributions":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." - }, - "TooManyTrustedSigners":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Your request contains more trusted signers than are allowed per distribution." - }, - "TrustedSignerDoesNotExist":{ - "type":"structure", - "members":{ - "Message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more of your trusted signers do not exist." - }, - "TrustedSigners":{ - "type":"structure", - "required":[ - "Enabled", - "Quantity" - ], - "members":{ - "Enabled":{ - "shape":"boolean", - "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." - }, - "Quantity":{ - "shape":"integer", - "documentation":"The number of trusted signers for this cache behavior." - }, - "Items":{ - "shape":"AwsAccountNumberList", - "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." - } - }, - "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." - }, - "UpdateCloudFrontOriginAccessIdentityRequest":{ - "type":"structure", - "required":[ - "CloudFrontOriginAccessIdentityConfig", - "Id" - ], - "members":{ - "CloudFrontOriginAccessIdentityConfig":{ - "shape":"CloudFrontOriginAccessIdentityConfig", - "documentation":"The identity's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"CloudFrontOriginAccessIdentityConfig" - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The identity's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to update an origin access identity.", - "payload":"CloudFrontOriginAccessIdentityConfig" - }, - "UpdateCloudFrontOriginAccessIdentityResult":{ - "type":"structure", - "members":{ - "CloudFrontOriginAccessIdentity":{ - "shape":"CloudFrontOriginAccessIdentity", - "documentation":"The origin access identity's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"CloudFrontOriginAccessIdentity" - }, - "UpdateDistributionRequest":{ - "type":"structure", - "required":[ - "DistributionConfig", - "Id" - ], - "members":{ - "DistributionConfig":{ - "shape":"DistributionConfig", - "documentation":"The distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"DistributionConfig" - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The distribution's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to update a distribution.", - "payload":"DistributionConfig" - }, - "UpdateDistributionResult":{ - "type":"structure", - "members":{ - "Distribution":{ - "shape":"Distribution", - "documentation":"The distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"Distribution" - }, - "UpdateStreamingDistributionRequest":{ - "type":"structure", - "required":[ - "StreamingDistributionConfig", - "Id" - ], - "members":{ - "StreamingDistributionConfig":{ - "shape":"StreamingDistributionConfig", - "documentation":"The streaming distribution's configuration information.", - "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, - "locationName":"StreamingDistributionConfig" - }, - "Id":{ - "shape":"string", - "location":"uri", - "locationName":"Id", - "documentation":"The streaming distribution's id." - }, - "IfMatch":{ - "shape":"string", - "location":"header", - "locationName":"If-Match", - "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The request to update a streaming distribution.", - "payload":"StreamingDistributionConfig" - }, - "UpdateStreamingDistributionResult":{ - "type":"structure", - "members":{ - "StreamingDistribution":{ - "shape":"StreamingDistribution", - "documentation":"The streaming distribution's information." - }, - "ETag":{ - "shape":"string", - "location":"header", - "locationName":"ETag", - "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." - } - }, - "documentation":"The returned result of the corresponding request.", - "payload":"StreamingDistribution" - }, - "ViewerCertificate":{ - "type":"structure", - "members":{ - "IAMCertificateId":{ - "shape":"string", - "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." - }, - "CloudFrontDefaultCertificate":{ - "shape":"boolean", - "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." - }, - "SSLSupportMethod":{ - "shape":"SSLSupportMethod", - "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." - }, - "MinimumProtocolVersion":{ - "shape":"MinimumProtocolVersion", - "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." - } - }, - "documentation":"A complex type that contains information about viewer certificates for this distribution." - }, - "ViewerProtocolPolicy":{ - "type":"string", - "enum":[ - "allow-all", - "https-only", - "redirect-to-https" - ] - }, - "boolean":{"type":"boolean"}, - "integer":{"type":"integer"}, - "long":{"type":"long"}, - "string":{"type":"string"}, - "timestamp":{"type":"timestamp"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.paginators.json deleted file mode 100644 index 51fbb907fa..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.paginators.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "pagination": { - "ListCloudFrontOriginAccessIdentities": { - "input_token": "Marker", - "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", - "limit_key": "MaxItems", - "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", - "result_key": "CloudFrontOriginAccessIdentityList.Items" - }, - "ListDistributions": { - "input_token": "Marker", - "output_token": "DistributionList.NextMarker", - "limit_key": "MaxItems", - "more_results": "DistributionList.IsTruncated", - "result_key": "DistributionList.Items" - }, - "ListInvalidations": { - "input_token": "Marker", - "output_token": "InvalidationList.NextMarker", - "limit_key": "MaxItems", - "more_results": "InvalidationList.IsTruncated", - "result_key": "InvalidationList.Items" - }, - "ListStreamingDistributions": { - "input_token": "Marker", - "output_token": "StreamingDistributionList.NextMarker", - "limit_key": "MaxItems", - "more_results": "StreamingDistributionList.IsTruncated", - "result_key": "StreamingDistributionList.Items" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.waiters.json deleted file mode 100644 index 6e044bc51b..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudfront/2014-10-21.waiters.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "version": 2, - "waiters": { - "DistributionDeployed": { - "delay": 60, - "operation": "GetDistribution", - "maxAttempts": 25, - "description": "Wait until a distribution is deployed.", - "acceptors": [ - { - "expected": "Deployed", - "matcher": "path", - "state": "success", - "argument": "Distribution.Status" - } - ] - }, - "InvalidationCompleted": { - "delay": 20, - "operation": "GetInvalidation", - "maxAttempts": 60, - "description": "Wait until an invalidation has completed.", - "acceptors": [ - { - "expected": "Completed", - "matcher": "path", - "state": "success", - "argument": "Invalidation.Status" - } - ] - }, - "StreamingDistributionDeployed": { - "delay": 60, - "operation": "GetStreamingDistribution", - "maxAttempts": 25, - "description": "Wait until a streaming distribution is deployed.", - "acceptors": [ - { - "expected": "Deployed", - "matcher": "path", - "state": "success", - "argument": "StreamingDistribution.Status" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudhsm/2014-05-30.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudhsm/2014-05-30.normal.json deleted file mode 100644 index e44d214350..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudhsm/2014-05-30.normal.json +++ /dev/null @@ -1,1302 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-05-30", - "endpointPrefix":"cloudhsm", - "jsonVersion":"1.1", - "serviceAbbreviation":"CloudHSM", - "serviceFullName":"Amazon CloudHSM", - "signatureVersion":"v4", - "targetPrefix":"CloudHsmFrontendService", - "protocol":"json" - }, - "documentation":"Contains the inputs for the CreateHapgRequest action.
" - }, - "output":{ - "shape":"CreateHapgResponse", - "documentation":"Contains the output of the CreateHAPartitionGroup action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
" - }, - "CreateHsm":{ - "name":"CreateHsm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateHsmRequest", - "documentation":"Contains the inputs for the CreateHsm action.
", - "locationName":"CreateHsmRequest" - }, - "output":{ - "shape":"CreateHsmResponse", - "documentation":"Contains the output of the CreateHsm action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.
" - }, - "CreateLunaClient":{ - "name":"CreateLunaClient", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateLunaClientRequest", - "documentation":"Contains the inputs for the CreateLunaClient action.
" - }, - "output":{ - "shape":"CreateLunaClientResponse", - "documentation":"Contains the output of the CreateLunaClient action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Creates an HSM client.
" - }, - "DeleteHapg":{ - "name":"DeleteHapg", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteHapgRequest", - "documentation":"Contains the inputs for the DeleteHapg action.
" - }, - "output":{ - "shape":"DeleteHapgResponse", - "documentation":"Contains the output of the DeleteHapg action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Deletes a high-availability partition group.
" - }, - "DeleteHsm":{ - "name":"DeleteHsm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteHsmRequest", - "documentation":"Contains the inputs for the DeleteHsm action.
", - "locationName":"DeleteHsmRequest" - }, - "output":{ - "shape":"DeleteHsmResponse", - "documentation":"Contains the output of the DeleteHsm action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.
" - }, - "DeleteLunaClient":{ - "name":"DeleteLunaClient", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLunaClientRequest"}, - "output":{"shape":"DeleteLunaClientResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Deletes a client.
" - }, - "DescribeHapg":{ - "name":"DescribeHapg", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeHapgRequest", - "documentation":"Contains the inputs for the DescribeHapg action.
" - }, - "output":{ - "shape":"DescribeHapgResponse", - "documentation":"Contains the output of the DescribeHapg action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Retrieves information about a high-availability partition group.
" - }, - "DescribeHsm":{ - "name":"DescribeHsm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeHsmRequest", - "documentation":"Contains the inputs for the DescribeHsm action.
" - }, - "output":{ - "shape":"DescribeHsmResponse", - "documentation":"Contains the output of the DescribeHsm action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
" - }, - "DescribeLunaClient":{ - "name":"DescribeLunaClient", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLunaClientRequest"}, - "output":{"shape":"DescribeLunaClientResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Retrieves information about an HSM client.
" - }, - "GetConfig":{ - "name":"GetConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetConfigRequest"}, - "output":{"shape":"GetConfigResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
" - }, - "ListAvailableZones":{ - "name":"ListAvailableZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListAvailableZonesRequest", - "documentation":"Contains the inputs for the ListAvailableZones action.
" - }, - "output":{"shape":"ListAvailableZonesResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Lists the Availability Zones that have available AWS CloudHSM capacity.
" - }, - "ListHapgs":{ - "name":"ListHapgs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHapgsRequest"}, - "output":{"shape":"ListHapgsResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Lists the high-availability partition groups for the account.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
" - }, - "ListHsms":{ - "name":"ListHsms", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListHsmsRequest"}, - "output":{ - "shape":"ListHsmsResponse", - "documentation":"Contains the output of the ListHsms action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Retrieves the identifiers of all of the HSMs provisioned for the current customer.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
" - }, - "ListLunaClients":{ - "name":"ListLunaClients", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLunaClientsRequest"}, - "output":{"shape":"ListLunaClientsResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Lists all of the clients.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
" - }, - "ModifyHapg":{ - "name":"ModifyHapg", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyHapgRequest"}, - "output":{"shape":"ModifyHapgResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Modifies an existing high-availability partition group.
" - }, - "ModifyHsm":{ - "name":"ModifyHsm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyHsmRequest", - "documentation":"Contains the inputs for the ModifyHsm action.
", - "locationName":"ModifyHsmRequest" - }, - "output":{ - "shape":"ModifyHsmResponse", - "documentation":"Contains the output of the ModifyHsm action.
" - }, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - { - "shape":"CloudHsmInternalException", - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - } - ], - "documentation":"Modifies an HSM.
" - }, - "ModifyLunaClient":{ - "name":"ModifyLunaClient", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyLunaClientRequest"}, - "output":{"shape":"ModifyLunaClientResponse"}, - "errors":[ - { - "shape":"CloudHsmServiceException", - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - } - ], - "documentation":"Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
" - } - }, - "shapes":{ - "AZ":{ - "type":"string", - "pattern":"[a-zA-Z0-9\\-]*" - }, - "AZList":{ - "type":"list", - "member":{"shape":"AZ"} - }, - "Boolean":{"type":"boolean"}, - "Certificate":{ - "type":"string", - "min":600, - "max":2400, - "pattern":"[\\w :+=./\\n-]*" - }, - "CertificateFingerprint":{ - "type":"string", - "pattern":"([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]" - }, - "ClientArn":{ - "type":"string", - "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}" - }, - "ClientLabel":{ - "type":"string", - "pattern":"[a-zA-Z0-9_.-]{2,64}" - }, - "ClientList":{ - "type":"list", - "member":{"shape":"ClientArn"} - }, - "ClientToken":{ - "type":"string", - "pattern":"[a-zA-Z0-9]{1,64}" - }, - "ClientVersion":{ - "type":"string", - "enum":[ - "5.1", - "5.3" - ] - }, - "CloudHsmInternalException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "fault":true, - "documentation":"Indicates that an internal error occurred.
" - }, - "CloudHsmObjectState":{ - "type":"string", - "enum":[ - "READY", - "UPDATING", - "DEGRADED" - ] - }, - "CloudHsmServiceException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"Additional information about the error.
" - }, - "retryable":{ - "shape":"Boolean", - "documentation":"Indicates if the action can be retried.
" - } - }, - "exception":true, - "documentation":"Indicates that an exception occurred in the AWS CloudHSM service.
" - }, - "CreateHapgRequest":{ - "type":"structure", - "required":["Label"], - "members":{ - "Label":{ - "shape":"Label", - "documentation":"The label of the new high-availability partition group.
" - } - }, - "documentation":"Contains the inputs for the CreateHapgRequest action.
" - }, - "CreateHapgResponse":{ - "type":"structure", - "members":{ - "HapgArn":{ - "shape":"HapgArn", - "documentation":"The ARN of the high-availability partition group.
" - } - }, - "documentation":"Contains the output of the CreateHAPartitionGroup action.
" - }, - "CreateHsmRequest":{ - "type":"structure", - "required":[ - "SubnetId", - "SshKey", - "IamRoleArn", - "SubscriptionType" - ], - "members":{ - "SubnetId":{ - "shape":"SubnetId", - "documentation":"The identifier of the subnet in your VPC in which to place the HSM.
", - "locationName":"SubnetId" - }, - "SshKey":{ - "shape":"SshKey", - "documentation":"The SSH public key to install on the HSM.
", - "locationName":"SshKey" - }, - "EniIp":{ - "shape":"IpAddress", - "documentation":"The IP address to assign to the HSM's ENI.
", - "locationName":"EniIp" - }, - "IamRoleArn":{ - "shape":"IamRoleArn", - "documentation":"The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
", - "locationName":"IamRoleArn" - }, - "ExternalId":{ - "shape":"ExternalId", - "documentation":"The external ID from IamRoleArn, if present.
", - "locationName":"ExternalId" - }, - "SubscriptionType":{ - "shape":"SubscriptionType", - "documentation":"The subscription type.
", - "locationName":"SubscriptionType" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
", - "locationName":"ClientToken" - }, - "SyslogIp":{ - "shape":"IpAddress", - "documentation":"The IP address for the syslog monitoring server.
", - "locationName":"SyslogIp" - } - }, - "documentation":"Contains the inputs for the CreateHsm action.
", - "locationName":"CreateHsmRequest" - }, - "CreateHsmResponse":{ - "type":"structure", - "members":{ - "HsmArn":{ - "shape":"HsmArn", - "documentation":"The ARN of the HSM.
" - } - }, - "documentation":"Contains the output of the CreateHsm action.
" - }, - "CreateLunaClientRequest":{ - "type":"structure", - "required":["Certificate"], - "members":{ - "Label":{ - "shape":"ClientLabel", - "documentation":"The label for the client.
" - }, - "Certificate":{ - "shape":"Certificate", - "documentation":"The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
" - } - }, - "documentation":"Contains the inputs for the CreateLunaClient action.
" - }, - "CreateLunaClientResponse":{ - "type":"structure", - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client.
" - } - }, - "documentation":"Contains the output of the CreateLunaClient action.
" - }, - "DeleteHapgRequest":{ - "type":"structure", - "required":["HapgArn"], - "members":{ - "HapgArn":{ - "shape":"HapgArn", - "documentation":"The ARN of the high-availability partition group to delete.
" - } - }, - "documentation":"Contains the inputs for the DeleteHapg action.
" - }, - "DeleteHapgResponse":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"String", - "documentation":"The status of the action.
" - } - }, - "documentation":"Contains the output of the DeleteHapg action.
" - }, - "DeleteHsmRequest":{ - "type":"structure", - "required":["HsmArn"], - "members":{ - "HsmArn":{ - "shape":"HsmArn", - "documentation":"The ARN of the HSM to delete.
", - "locationName":"HsmArn" - } - }, - "documentation":"Contains the inputs for the DeleteHsm action.
", - "locationName":"DeleteHsmRequest" - }, - "DeleteHsmResponse":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"String", - "documentation":"The status of the action.
" - } - }, - "documentation":"Contains the output of the DeleteHsm action.
" - }, - "DeleteLunaClientRequest":{ - "type":"structure", - "required":["ClientArn"], - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client to delete.
" - } - } - }, - "DeleteLunaClientResponse":{ - "type":"structure", - "required":["Status"], - "members":{ - "Status":{ - "shape":"String", - "documentation":"The status of the action.
" - } - } - }, - "DescribeHapgRequest":{ - "type":"structure", - "required":["HapgArn"], - "members":{ - "HapgArn":{ - "shape":"HapgArn", - "documentation":"The ARN of the high-availability partition group to describe.
" - } - }, - "documentation":"Contains the inputs for the DescribeHapg action.
" - }, - "DescribeHapgResponse":{ - "type":"structure", - "members":{ - "HapgArn":{ - "shape":"HapgArn", - "documentation":"The ARN of the high-availability partition group.
" - }, - "HapgSerial":{ - "shape":"String", - "documentation":"The serial number of the high-availability partition group.
" - }, - "HsmsLastActionFailed":{"shape":"HsmList"}, - "HsmsPendingDeletion":{"shape":"HsmList"}, - "HsmsPendingRegistration":{"shape":"HsmList"}, - "Label":{ - "shape":"Label", - "documentation":"The label for the high-availability partition group.
" - }, - "LastModifiedTimestamp":{ - "shape":"Timestamp", - "documentation":"The date and time the high-availability partition group was last modified.
" - }, - "PartitionSerialList":{ - "shape":"PartitionSerialList", - "documentation":"The list of partition serial numbers that belong to the high-availability partition group.
" - }, - "State":{ - "shape":"CloudHsmObjectState", - "documentation":"The state of the high-availability partition group.
" - } - }, - "documentation":"Contains the output of the DescribeHapg action.
" - }, - "DescribeHsmRequest":{ - "type":"structure", - "members":{ - "HsmArn":{ - "shape":"HsmArn", - "documentation":"The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
" - }, - "HsmSerialNumber":{ - "shape":"HsmSerialNumber", - "documentation":"The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
" - } - }, - "documentation":"Contains the inputs for the DescribeHsm action.
" - }, - "DescribeHsmResponse":{ - "type":"structure", - "members":{ - "HsmArn":{ - "shape":"HsmArn", - "documentation":"The ARN of the HSM.
" - }, - "Status":{ - "shape":"HsmStatus", - "documentation":"The status of the HSM.
" - }, - "StatusDetails":{ - "shape":"String", - "documentation":"Contains additional information about the status of the HSM.
" - }, - "AvailabilityZone":{ - "shape":"AZ", - "documentation":"The Availability Zone that the HSM is in.
" - }, - "EniId":{ - "shape":"EniId", - "documentation":"The identifier of the elastic network interface (ENI) attached to the HSM.
" - }, - "EniIp":{ - "shape":"IpAddress", - "documentation":"The IP address assigned to the HSM's ENI.
" - }, - "SubscriptionType":{ - "shape":"SubscriptionType", - "documentation":"The subscription type.
" - }, - "SubscriptionStartDate":{ - "shape":"Timestamp", - "documentation":"The subscription start date.
" - }, - "SubscriptionEndDate":{ - "shape":"Timestamp", - "documentation":"The subscription end date.
" - }, - "VpcId":{ - "shape":"VpcId", - "documentation":"The identifier of the VPC that the HSM is in.
" - }, - "SubnetId":{ - "shape":"SubnetId", - "documentation":"The identifier of the subnet the HSM is in.
" - }, - "IamRoleArn":{ - "shape":"IamRoleArn", - "documentation":"The ARN of the IAM role assigned to the HSM.
" - }, - "SerialNumber":{ - "shape":"HsmSerialNumber", - "documentation":"The serial number of the HSM.
" - }, - "VendorName":{ - "shape":"String", - "documentation":"The name of the HSM vendor.
" - }, - "HsmType":{ - "shape":"String", - "documentation":"The HSM model type.
" - }, - "SoftwareVersion":{ - "shape":"String", - "documentation":"The HSM software version.
" - }, - "SshPublicKey":{ - "shape":"SshKey", - "documentation":"The public SSH key.
" - }, - "SshKeyLastUpdated":{ - "shape":"Timestamp", - "documentation":"The date and time the SSH key was last updated.
" - }, - "ServerCertUri":{ - "shape":"String", - "documentation":"The URI of the certificate server.
" - }, - "ServerCertLastUpdated":{ - "shape":"Timestamp", - "documentation":"The date and time the server certificate was last updated.
" - }, - "Partitions":{ - "shape":"PartitionList", - "documentation":"The list of partitions on the HSM.
" - } - }, - "documentation":"Contains the output of the DescribeHsm action.
" - }, - "DescribeLunaClientRequest":{ - "type":"structure", - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client.
" - }, - "CertificateFingerprint":{ - "shape":"CertificateFingerprint", - "documentation":"The certificate fingerprint.
" - } - } - }, - "DescribeLunaClientResponse":{ - "type":"structure", - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client.
" - }, - "Certificate":{ - "shape":"Certificate", - "documentation":"The certificate installed on the HSMs used by this client.
" - }, - "CertificateFingerprint":{ - "shape":"CertificateFingerprint", - "documentation":"The certificate fingerprint.
" - }, - "LastModifiedTimestamp":{ - "shape":"Timestamp", - "documentation":"The date and time the client was last modified.
" - }, - "Label":{ - "shape":"Label", - "documentation":"The label of the client.
" - } - } - }, - "EniId":{ - "type":"string", - "pattern":"eni-[0-9a-f]{8}" - }, - "ExternalId":{ - "type":"string", - "pattern":"[\\w :+=./-]*" - }, - "GetConfigRequest":{ - "type":"structure", - "required":[ - "ClientArn", - "ClientVersion", - "HapgList" - ], - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client.
" - }, - "ClientVersion":{ - "shape":"ClientVersion", - "documentation":"The client version.
" - }, - "HapgList":{ - "shape":"HapgList", - "documentation":"A list of ARNs that identify the high-availability partition groups that are associated with the client.
" - } - } - }, - "GetConfigResponse":{ - "type":"structure", - "members":{ - "ConfigType":{ - "shape":"String", - "documentation":"The type of credentials.
" - }, - "ConfigFile":{ - "shape":"String", - "documentation":"The chrystoki.conf configuration file.
" - }, - "ConfigCred":{ - "shape":"String", - "documentation":"The certificate file containing the server.pem files of the HSMs.
" - } - } - }, - "HapgArn":{ - "type":"string", - "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}" - }, - "HapgList":{ - "type":"list", - "member":{"shape":"HapgArn"} - }, - "HsmArn":{ - "type":"string", - "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}", - "documentation":"An ARN that identifies an HSM.
" - }, - "HsmList":{ - "type":"list", - "member":{"shape":"HsmArn"}, - "documentation":"Contains a list of ARNs that identify the HSMs.
" - }, - "HsmSerialNumber":{ - "type":"string", - "pattern":"\\d{1,16}" - }, - "HsmStatus":{ - "type":"string", - "enum":[ - "PENDING", - "RUNNING", - "UPDATING", - "SUSPENDED", - "TERMINATING", - "TERMINATED", - "DEGRADED" - ] - }, - "IamRoleArn":{ - "type":"string", - "pattern":"arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}" - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"Indicates that one or more of the request parameters are not valid.
" - }, - "IpAddress":{ - "type":"string", - "pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" - }, - "Label":{ - "type":"string", - "pattern":"[a-zA-Z0-9_.-]{1,64}" - }, - "ListAvailableZonesRequest":{ - "type":"structure", - "members":{ - }, - "documentation":"Contains the inputs for the ListAvailableZones action.
" - }, - "ListAvailableZonesResponse":{ - "type":"structure", - "members":{ - "AZList":{ - "shape":"AZList", - "documentation":"The list of Availability Zones that have available AWS CloudHSM capacity.
" - } - } - }, - "ListHapgsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.
" - } - } - }, - "ListHapgsResponse":{ - "type":"structure", - "required":["HapgList"], - "members":{ - "HapgList":{ - "shape":"HapgList", - "documentation":"The list of high-availability partition groups.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.
" - } - } - }, - "ListHsmsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"The NextToken value from a previous call to ListHsms. Pass null if this is the first call.
" - } - } - }, - "ListHsmsResponse":{ - "type":"structure", - "members":{ - "HsmList":{ - "shape":"HsmList", - "documentation":"The list of ARNs that identify the HSMs.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.
" - } - }, - "documentation":"Contains the output of the ListHsms action.
" - }, - "ListLunaClientsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
" - } - } - }, - "ListLunaClientsResponse":{ - "type":"structure", - "required":["ClientList"], - "members":{ - "ClientList":{ - "shape":"ClientList", - "documentation":"The list of clients.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.
" - } - } - }, - "ModifyHapgRequest":{ - "type":"structure", - "required":["HapgArn"], - "members":{ - "HapgArn":{ - "shape":"HapgArn", - "documentation":"The ARN of the high-availability partition group to modify.
" - }, - "Label":{ - "shape":"Label", - "documentation":"The new label for the high-availability partition group.
" - }, - "PartitionSerialList":{ - "shape":"PartitionSerialList", - "documentation":"The list of partition serial numbers to make members of the high-availability partition group.
" - } - } - }, - "ModifyHapgResponse":{ - "type":"structure", - "members":{ - "HapgArn":{ - "shape":"HapgArn", - "documentation":"The ARN of the high-availability partition group.
" - } - } - }, - "ModifyHsmRequest":{ - "type":"structure", - "required":["HsmArn"], - "members":{ - "HsmArn":{ - "shape":"HsmArn", - "documentation":"The ARN of the HSM to modify.
", - "locationName":"HsmArn" - }, - "SubnetId":{ - "shape":"SubnetId", - "documentation":"The new identifier of the subnet that the HSM is in.
", - "locationName":"SubnetId" - }, - "EniIp":{ - "shape":"IpAddress", - "documentation":"The new IP address for the elastic network interface attached to the HSM.
", - "locationName":"EniIp" - }, - "IamRoleArn":{ - "shape":"IamRoleArn", - "documentation":"The new IAM role ARN.
", - "locationName":"IamRoleArn" - }, - "ExternalId":{ - "shape":"ExternalId", - "documentation":"The new external ID.
", - "locationName":"ExternalId" - }, - "SyslogIp":{ - "shape":"IpAddress", - "documentation":"The new IP address for the syslog monitoring server.
", - "locationName":"SyslogIp" - } - }, - "documentation":"Contains the inputs for the ModifyHsm action.
", - "locationName":"ModifyHsmRequest" - }, - "ModifyHsmResponse":{ - "type":"structure", - "members":{ - "HsmArn":{ - "shape":"HsmArn", - "documentation":"The ARN of the HSM.
" - } - }, - "documentation":"Contains the output of the ModifyHsm action.
" - }, - "ModifyLunaClientRequest":{ - "type":"structure", - "required":[ - "ClientArn", - "Certificate" - ], - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client.
" - }, - "Certificate":{ - "shape":"Certificate", - "documentation":"The new certificate for the client.
" - } - } - }, - "ModifyLunaClientResponse":{ - "type":"structure", - "members":{ - "ClientArn":{ - "shape":"ClientArn", - "documentation":"The ARN of the client.
" - } - } - }, - "PaginationToken":{ - "type":"string", - "pattern":"[a-zA-Z0-9+/]*" - }, - "PartitionArn":{ - "type":"string", - "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}" - }, - "PartitionList":{ - "type":"list", - "member":{"shape":"PartitionArn"} - }, - "PartitionSerial":{ - "type":"string", - "pattern":"\\d{9}" - }, - "PartitionSerialList":{ - "type":"list", - "member":{"shape":"PartitionSerial"} - }, - "SshKey":{ - "type":"string", - "pattern":"[a-zA-Z0-9+/= ._:\\\\@-]*" - }, - "String":{ - "type":"string", - "pattern":"[\\w :+=./\\\\-]*" - }, - "SubnetId":{ - "type":"string", - "pattern":"subnet-[0-9a-f]{8}" - }, - "SubscriptionType":{ - "type":"string", - "enum":["PRODUCTION"] - }, - "Timestamp":{ - "type":"string", - "pattern":"\\d*" - }, - "VpcId":{ - "type":"string", - "pattern":"vpc-[0-9a-f]{8}" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudsearch/2013-01-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudsearch/2013-01-01.normal.json deleted file mode 100644 index 781db11762..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudsearch/2013-01-01.normal.json +++ /dev/null @@ -1,2701 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2013-01-01", - "endpointPrefix":"cloudsearch", - "serviceFullName":"Amazon CloudSearch", - "signatureVersion":"v4", - "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2013-01-01/", - "protocol":"query" - }, - "documentation":"You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.
The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
", - "operations":{ - "BuildSuggesters":{ - "name":"BuildSuggesters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"BuildSuggestersRequest", - "documentation":"Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.
The result of a BuildSuggester request. Contains a list of the fields used for suggestions.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
" - }, - "CreateDomain":{ - "name":"CreateDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDomainRequest", - "documentation":"Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.
The result of a CreateDomainRequest. Contains the status of a newly created domain.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - } - ], - "documentation":"Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
" - }, - "DefineAnalysisScheme":{ - "name":"DefineAnalysisScheme", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DefineAnalysisSchemeRequest", - "documentation":"Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.
The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.
The result of a DefineExpression request. Contains the status of the newly-configured expression.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.
The result of a DefineIndexField request. Contains the status of the newly-configured index field.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.
The result of a DefineSuggester request. Contains the status of the newly-configured suggester.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
" - }, - "DeleteAnalysisScheme":{ - "name":"DeleteAnalysisScheme", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteAnalysisSchemeRequest", - "documentation":"Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.
The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
" - }, - "DeleteDomain":{ - "name":"DeleteDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDomainRequest", - "documentation":"Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - } - ], - "documentation":"Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
" - }, - "DeleteExpression":{ - "name":"DeleteExpression", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteExpressionRequest", - "documentation":"Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.
The result of a DeleteExpression request. Specifies the expression being deleted.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.
The result of a DeleteIndexField request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.
The result of a DeleteSuggester request. Contains the status of the deleted suggester.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
" - }, - "DescribeAnalysisSchemes":{ - "name":"DescribeAnalysisSchemes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeAnalysisSchemesRequest", - "documentation":"Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - }, - { - "shape":"DisabledOperationException", - "error":{ - "code":"DisabledAction", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted an operation which is not enabled.
" - } - ], - "documentation":"Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.
The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - } - ], - "documentation":"Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.
The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
" - }, - "DescribeServiceAccessPolicies":{ - "name":"DescribeServiceAccessPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeServiceAccessPoliciesRequest", - "documentation":"Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The result of a DescribeServiceAccessPolicies request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.
Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The result of a DescribeSuggesters request.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.
The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - } - ], - "documentation":"Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.
The result of a ListDomainNames request. Contains a list of the domains owned by an account.
An error occurred while processing the request.
" - } - ], - "documentation":"Lists all search domains owned by an account.
" - }, - "UpdateAvailabilityOptions":{ - "name":"UpdateAvailabilityOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateAvailabilityOptionsRequest", - "documentation":"Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.
The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - }, - { - "shape":"DisabledOperationException", - "error":{ - "code":"DisabledAction", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted an operation which is not enabled.
" - } - ], - "documentation":"Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
" - }, - "UpdateScalingParameters":{ - "name":"UpdateScalingParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateScalingParametersRequest", - "documentation":"Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.
The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - } - ], - "documentation":"Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
" - }, - "UpdateServiceAccessPolicies":{ - "name":"UpdateServiceAccessPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateServiceAccessPoliciesRequest", - "documentation":"Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.
The result of an UpdateServiceAccessPolicies request. Contains the new access policies.
An error occurred while processing the request.
" - }, - { - "shape":"InternalException", - "error":{ - "code":"InternalException", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a resource limit has already been met.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - }, - { - "shape":"InvalidTypeException", - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - } - ], - "documentation":"Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
" - } - }, - "shapes":{ - "APIVersion":{ - "type":"string", - "documentation":"The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.
" - }, - "ARN":{ - "type":"string", - "documentation":"The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
" - }, - "AccessPoliciesStatus":{ - "type":"structure", - "required":[ - "Options", - "Status" - ], - "members":{ - "Options":{"shape":"PolicyDocument"}, - "Status":{"shape":"OptionStatus"} - }, - "documentation":"The configured access rules for the domain's document and search endpoints, and the current status of those rules.
" - }, - "AlgorithmicStemming":{ - "type":"string", - "enum":[ - "none", - "minimal", - "light", - "full" - ] - }, - "AnalysisOptions":{ - "type":"structure", - "members":{ - "Synonyms":{ - "shape":"String", - "documentation":"A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
" - }, - "Stopwords":{ - "shape":"String", - "documentation":"A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
" - }, - "AlgorithmicStemming":{ - "shape":"AlgorithmicStemming", - "documentation":"The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
" - }, - "AnalysisScheme":{ - "type":"structure", - "required":[ - "AnalysisSchemeName", - "AnalysisSchemeLanguage" - ], - "members":{ - "AnalysisSchemeName":{"shape":"StandardName"}, - "AnalysisSchemeLanguage":{"shape":"AnalysisSchemeLanguage"}, - "AnalysisOptions":{"shape":"AnalysisOptions"} - }, - "documentation":"Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.
An IETF RFC 4646 language code or mul for multiple languages.
The status and configuration of an AnalysisScheme.
A list of the analysis schemes configured for a domain.
" - }, - "AvailabilityOptionsStatus":{ - "type":"structure", - "required":[ - "Options", - "Status" - ], - "members":{ - "Options":{ - "shape":"MultiAZ", - "documentation":"The availability options configured for the domain.
" - }, - "Status":{"shape":"OptionStatus"} - }, - "documentation":"The status and configuration of the domain's availability options.
" - }, - "BaseException":{ - "type":"structure", - "members":{ - "Code":{"shape":"ErrorCode"}, - "Message":{"shape":"ErrorMessage"} - }, - "exception":true, - "documentation":"An error occurred while processing the request.
" - }, - "Boolean":{"type":"boolean"}, - "BuildSuggestersRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{"shape":"DomainName"} - }, - "documentation":"Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.
The result of a BuildSuggester request. Contains a list of the fields used for suggestions.
A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.
" - } - }, - "documentation":"Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.
The result of a CreateDomainRequest. Contains the status of a newly created domain.
A list of source fields to map to the field.
" - }, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - } - }, - "documentation":"Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.
Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - }, - "SortEnabled":{ - "shape":"Boolean", - "documentation":"Whether the field can be used to sort the search results.
" - } - }, - "documentation":"Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.
Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.
The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.
Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.
The result of a DefineExpression request. Contains the status of the newly-configured expression.
The index field and field options you want to configure.
" - } - }, - "documentation":"Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.
The result of a DefineIndexField request. Contains the status of the newly-configured index field.
Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.
The result of a DefineSuggester request. Contains the status of the newly-configured suggester.
The name of the analysis scheme you want to delete.
" - } - }, - "documentation":"Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.
The status of the analysis scheme being deleted.
" - } - }, - "documentation":"The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.
The name of the domain you want to permanently delete.
" - } - }, - "documentation":"Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.
The name of the Expression to delete.
Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.
The status of the expression being deleted.
" - } - }, - "documentation":"The result of a DeleteExpression request. Specifies the expression being deleted.
The name of the index field your want to remove from the domain's indexing options.
" - } - }, - "documentation":"Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.
The status of the index field being deleted.
" - } - }, - "documentation":"The result of a DeleteIndexField request.
Specifies the name of the suggester you want to delete.
" - } - }, - "documentation":"Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.
The status of the suggester being deleted.
" - } - }, - "documentation":"The result of a DeleteSuggester request. Contains the status of the deleted suggester.
The name of the domain you want to describe.
" - }, - "AnalysisSchemeNames":{ - "shape":"StandardNameList", - "documentation":"The analysis schemes you want to describe.
" - }, - "Deployed":{ - "shape":"Boolean", - "documentation":"Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The analysis scheme descriptions.
" - } - }, - "documentation":"The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.
The name of the domain you want to describe.
" - }, - "Deployed":{ - "shape":"Boolean", - "documentation":"Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
" - } - }, - "documentation":"The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.
The names of the domains you want to include in the response.
" - } - }, - "documentation":"Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.
The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.
The name of the domain you want to describe.
" - }, - "ExpressionNames":{ - "shape":"StandardNameList", - "documentation":"Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.
Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The expressions configured for the domain.
" - } - }, - "documentation":"The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.
The name of the domain you want to describe.
" - }, - "FieldNames":{ - "shape":"DynamicFieldNameList", - "documentation":"A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
" - }, - "Deployed":{ - "shape":"Boolean", - "documentation":"Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The index fields configured for the domain.
" - } - }, - "documentation":"The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.
Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.
The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.
The name of the domain you want to describe.
" - }, - "Deployed":{ - "shape":"Boolean", - "documentation":"Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The access rules configured for the domain specified in the request.
" - } - }, - "documentation":"The result of a DescribeServiceAccessPolicies request.
The name of the domain you want to describe.
" - }, - "SuggesterNames":{ - "shape":"StandardNameList", - "documentation":"The suggesters you want to describe.
" - }, - "Deployed":{ - "shape":"Boolean", - "documentation":"Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
The suggesters configured for the domain specified in the request.
" - } - }, - "documentation":"The result of a DescribeSuggesters request.
The request was rejected because it attempted an operation which is not enabled.
" - }, - "DocumentSuggesterOptions":{ - "type":"structure", - "required":["SourceField"], - "members":{ - "SourceField":{ - "shape":"FieldName", - "documentation":"The name of the index field you want to use for suggestions.
" - }, - "FuzzyMatching":{ - "shape":"SuggesterFuzzyMatching", - "documentation":"The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.
An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
Options for a search suggester.
" - }, - "DomainId":{ - "type":"string", - "min":1, - "max":64, - "documentation":"An internally generated unique identifier for a domain.
" - }, - "DomainName":{ - "type":"string", - "min":3, - "max":28, - "pattern":"[a-z][a-z0-9\\-]+", - "documentation":"A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
" - }, - "DomainNameList":{ - "type":"list", - "member":{"shape":"DomainName"}, - "documentation":"A list of domain names.
" - }, - "DomainNameMap":{ - "type":"map", - "key":{"shape":"DomainName"}, - "value":{"shape":"APIVersion"}, - "documentation":"A collection of domain names.
" - }, - "DomainStatus":{ - "type":"structure", - "required":[ - "DomainId", - "DomainName", - "RequiresIndexDocuments" - ], - "members":{ - "DomainId":{"shape":"DomainId"}, - "DomainName":{"shape":"DomainName"}, - "ARN":{"shape":"ARN"}, - "Created":{ - "shape":"Boolean", - "documentation":"True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
" - }, - "Deleted":{ - "shape":"Boolean", - "documentation":"True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
" - }, - "DocService":{ - "shape":"ServiceEndpoint", - "documentation":"The service endpoint for updating documents in a search domain.
" - }, - "SearchService":{ - "shape":"ServiceEndpoint", - "documentation":"The service endpoint for requesting search results from a search domain.
" - }, - "RequiresIndexDocuments":{ - "shape":"Boolean", - "documentation":"True if IndexDocuments needs to be called to activate the current domain configuration.
" - }, - "Processing":{ - "shape":"Boolean", - "documentation":"True if processing is being done to activate the current domain configuration.
" - }, - "SearchInstanceType":{ - "shape":"SearchInstanceType", - "documentation":"The instance type that is being used to process search requests.
" - }, - "SearchPartitionCount":{ - "shape":"PartitionCount", - "documentation":"The number of partitions across which the search index is spread.
" - }, - "SearchInstanceCount":{ - "shape":"InstanceCount", - "documentation":"The number of search instances that are available to process search requests.
" - }, - "Limits":{"shape":"Limits"} - }, - "documentation":"The current status of the search domain.
" - }, - "DomainStatusList":{ - "type":"list", - "member":{"shape":"DomainStatus"}, - "documentation":"A list that contains the status of each requested domain.
" - }, - "Double":{"type":"double"}, - "DoubleArrayOptions":{ - "type":"structure", - "members":{ - "DefaultValue":{ - "shape":"Double", - "documentation":"A value to use for the field if the field isn't specified for a document." - }, - "SourceFields":{ - "shape":"FieldNameCommaList", - "documentation":"A list of source fields to map to the field.
" - }, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - } - }, - "documentation":"Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
" - }, - "SourceField":{ - "shape":"FieldName", - "documentation":"The name of the source field to map to the field.
" - }, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - }, - "SortEnabled":{ - "shape":"Boolean", - "documentation":"Whether the field can be used to sort the search results.
" - } - }, - "documentation":"Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
A machine-parsable string error or warning code.
" - }, - "ErrorMessage":{ - "type":"string", - "documentation":"A human-readable string error or warning message.
" - }, - "Expression":{ - "type":"structure", - "required":[ - "ExpressionName", - "ExpressionValue" - ], - "members":{ - "ExpressionName":{"shape":"StandardName"}, - "ExpressionValue":{"shape":"ExpressionValue"} - }, - "documentation":"A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.
" - }, - "ExpressionStatus":{ - "type":"structure", - "required":[ - "Options", - "Status" - ], - "members":{ - "Options":{ - "shape":"Expression", - "documentation":"The expression that is evaluated for sorting while processing a search request.
" - }, - "Status":{"shape":"OptionStatus"} - }, - "documentation":"The value of an Expression and its current status.
Contains the status of multiple expressions.
" - }, - "ExpressionValue":{ - "type":"string", - "min":1, - "max":10240, - "documentation":"The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name \"score\" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
A list of field names.
" - }, - "FieldValue":{ - "type":"string", - "min":0, - "max":1024, - "documentation":"The value of a field attribute.
" - }, - "IndexDocumentsRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{"shape":"DomainName"} - }, - "documentation":"Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.
The names of the fields that are currently being indexed.
" - } - }, - "documentation":"The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name \"score\" is reserved and cannot be specified as field or expression name.
" - }, - "IndexFieldType":{"shape":"IndexFieldType"}, - "IntOptions":{"shape":"IntOptions"}, - "DoubleOptions":{"shape":"DoubleOptions"}, - "LiteralOptions":{"shape":"LiteralOptions"}, - "TextOptions":{"shape":"TextOptions"}, - "DateOptions":{"shape":"DateOptions"}, - "LatLonOptions":{"shape":"LatLonOptions"}, - "IntArrayOptions":{"shape":"IntArrayOptions"}, - "DoubleArrayOptions":{"shape":"DoubleArrayOptions"}, - "LiteralArrayOptions":{"shape":"LiteralArrayOptions"}, - "TextArrayOptions":{"shape":"TextArrayOptions"}, - "DateArrayOptions":{"shape":"DateArrayOptions"} - }, - "documentation":"Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.
The value of an IndexField and its current status.
Contains the status of multiple index fields.
" - }, - "IndexFieldType":{ - "type":"string", - "enum":[ - "int", - "double", - "literal", - "text", - "date", - "latlon", - "int-array", - "double-array", - "literal-array", - "text-array", - "date-array" - ], - "documentation":"The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
" - }, - "InstanceCount":{ - "type":"integer", - "min":1 - }, - "IntArrayOptions":{ - "type":"structure", - "members":{ - "DefaultValue":{ - "shape":"Long", - "documentation":"A value to use for the field if the field isn't specified for a document." - }, - "SourceFields":{ - "shape":"FieldNameCommaList", - "documentation":"A list of source fields to map to the field.
" - }, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - } - }, - "documentation":"Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.
The name of the source field to map to the field.
" - }, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - }, - "SortEnabled":{ - "shape":"Boolean", - "documentation":"Whether the field can be used to sort the search results.
" - } - }, - "documentation":"Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
" - }, - "InvalidTypeException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidType", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it specified an invalid type definition.
" - }, - "LatLonOptions":{ - "type":"structure", - "members":{ - "DefaultValue":{ - "shape":"FieldValue", - "documentation":"A value to use for the field if the field isn't specified for a document." - }, - "SourceField":{"shape":"FieldName"}, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - }, - "SortEnabled":{ - "shape":"Boolean", - "documentation":"Whether the field can be used to sort the search results.
" - } - }, - "documentation":"Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.
The request was rejected because a resource limit has already been met.
" - }, - "Limits":{ - "type":"structure", - "required":[ - "MaximumReplicationCount", - "MaximumPartitionCount" - ], - "members":{ - "MaximumReplicationCount":{"shape":"MaximumReplicationCount"}, - "MaximumPartitionCount":{"shape":"MaximumPartitionCount"} - } - }, - "ListDomainNamesResponse":{ - "type":"structure", - "members":{ - "DomainNames":{ - "shape":"DomainNameMap", - "documentation":"The names of the search domains owned by an account.
" - } - }, - "documentation":"The result of a ListDomainNames request. Contains a list of the domains owned by an account.
A list of source fields to map to the field.
" - }, - "FacetEnabled":{ - "shape":"Boolean", - "documentation":"Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - } - }, - "documentation":"Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.
Whether facet information can be returned for the field.
" - }, - "SearchEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field are searchable.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - }, - "SortEnabled":{ - "shape":"Boolean", - "documentation":"Whether the field can be used to sort the search results.
" - } - }, - "documentation":"Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.
The state of processing a change to an option. One of:
A timestamp for when this option was created.
" - }, - "UpdateDate":{ - "shape":"UpdateTimestamp", - "documentation":"A timestamp for when this option was last updated.
" - }, - "UpdateVersion":{ - "shape":"UIntValue", - "documentation":"A unique integer that indicates when this option was last updated.
" - }, - "State":{ - "shape":"OptionState", - "documentation":"The state of processing a change to an option. Possible values:
RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is in the process of being activated. Active: the option's latest value is completely deployed.FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.Indicates that the option will be deleted once processing is complete.
" - } - }, - "documentation":"The status of domain configuration option.
" - }, - "PartitionCount":{ - "type":"integer", - "min":1, - "documentation":"The number of partitions used to hold the domain's index.
" - }, - "PartitionInstanceType":{ - "type":"string", - "enum":[ - "search.m1.small", - "search.m1.large", - "search.m2.xlarge", - "search.m2.2xlarge" - ], - "documentation":"The instance type (such as search.m1.small) on which an index partition is hosted.
Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.
" - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to reference a resource that does not exist.
" - }, - "ScalingParameters":{ - "type":"structure", - "members":{ - "DesiredInstanceType":{ - "shape":"PartitionInstanceType", - "documentation":"The instance type that you want to preconfigure for your domain. For example, search.m1.small.
The number of replicas you want to preconfigure for each index partition.
" - }, - "DesiredPartitionCount":{ - "shape":"UIntValue", - "documentation":"The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.
The desired instance type and desired number of replicas of each index partition.
" - }, - "ScalingParametersStatus":{ - "type":"structure", - "required":[ - "Options", - "Status" - ], - "members":{ - "Options":{"shape":"ScalingParameters"}, - "Status":{"shape":"OptionStatus"} - }, - "documentation":"The status and configuration of a search domain's scaling parameters.
" - }, - "SearchInstanceType":{ - "type":"string", - "documentation":"The instance type (such as search.m1.small) that is being used to process search requests.
The endpoint to which service requests can be submitted.
" - }, - "ServiceUrl":{ - "type":"string", - "documentation":"The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
" - }, - "StandardNameList":{ - "type":"list", - "member":{"shape":"StandardName"} - }, - "String":{"type":"string"}, - "Suggester":{ - "type":"structure", - "required":[ - "SuggesterName", - "DocumentSuggesterOptions" - ], - "members":{ - "SuggesterName":{"shape":"StandardName"}, - "DocumentSuggesterOptions":{"shape":"DocumentSuggesterOptions"} - }, - "documentation":"Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.
The value of a Suggester and its current status.
Contains the status of multiple suggesters.
" - }, - "TextArrayOptions":{ - "type":"structure", - "members":{ - "DefaultValue":{ - "shape":"FieldValue", - "documentation":"A value to use for the field if the field isn't specified for a document." - }, - "SourceFields":{ - "shape":"FieldNameCommaList", - "documentation":"A list of source fields to map to the field.
" - }, - "ReturnEnabled":{ - "shape":"Boolean", - "documentation":"Whether the contents of the field can be returned in the search results.
" - }, - "HighlightEnabled":{ - "shape":"Boolean", - "documentation":"Whether highlights can be returned for the field.
" - }, - "AnalysisScheme":{ - "shape":"Word", - "documentation":"The name of an analysis scheme for a text-array field.
Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.
Whether the contents of the field can be returned in the search results.
" - }, - "SortEnabled":{ - "shape":"Boolean", - "documentation":"Whether the field can be used to sort the search results.
" - }, - "HighlightEnabled":{ - "shape":"Boolean", - "documentation":"Whether highlights can be returned for the field.
" - }, - "AnalysisScheme":{ - "shape":"Word", - "documentation":"The name of an analysis scheme for a text field.
Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.
You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.
Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.
The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
" - } - }, - "documentation":"The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.
Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.
The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.
The access rules you want to configure. These rules replace any existing rules.
" - } - }, - "documentation":"Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.
The access rules configured for the domain.
" - } - }, - "documentation":"The result of an UpdateServiceAccessPolicies request. Contains the new access policies.
You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
", - "operations":{ - "Search":{ - "name":"Search", - "http":{ - "method":"GET", - "requestUri":"/2013-01-01/search?format=sdk&pretty=true" - }, - "input":{ - "shape":"SearchRequest", - "documentation":"Container for the parameters to the Search request.
The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.
Information about any problems encountered while processing a search request.
" - } - ], - "documentation":"Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:
simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes. structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.lucene: specify search criteria using the Apache Lucene query parser syntax.dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.
The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.
Container for the parameters to the Suggest request.
Contains the response to a Suggest request.
Information about any problems encountered while processing a search request.
" - } - ], - "documentation":"Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.
For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.
The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.
Container for the parameters to the UploadDocuments request.
Contains the response to an UploadDocuments request.
Information about any problems encountered while processing an upload request.
" - } - ], - "documentation":"Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.
The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.
For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.
" - } - }, - "shapes":{ - "Adds":{"type":"long"}, - "Blob":{ - "type":"blob", - "streaming":true - }, - "Bucket":{ - "type":"structure", - "members":{ - "value":{ - "shape":"String", - "documentation":"The facet value being counted.
" - }, - "count":{ - "shape":"Long", - "documentation":"The number of hits that contain the facet value in the specified facet field.
" - } - }, - "documentation":"A container for facet information.
" - }, - "BucketInfo":{ - "type":"structure", - "members":{ - "buckets":{ - "shape":"BucketList", - "documentation":"A list of the calculated facet values and counts.
" - } - }, - "documentation":"A container for the calculated facet values and counts.
" - }, - "BucketList":{ - "type":"list", - "member":{"shape":"Bucket"} - }, - "ContentType":{ - "type":"string", - "enum":[ - "application/json", - "application/xml" - ] - }, - "Cursor":{"type":"string"}, - "Deletes":{"type":"long"}, - "DocumentServiceException":{ - "type":"structure", - "members":{ - "status":{ - "shape":"String", - "documentation":"The return status of a document upload request, error or success.
The description of the errors returned by the document service.
" - } - }, - "exception":true, - "documentation":"Information about any problems encountered while processing an upload request.
" - }, - "DocumentServiceWarning":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The description for a warning returned by the document service.
" - } - }, - "documentation":"A warning returned by the document service when an issue is discovered while processing an upload request.
" - }, - "DocumentServiceWarnings":{ - "type":"list", - "member":{"shape":"DocumentServiceWarning"} - }, - "Expr":{"type":"string"}, - "Facet":{"type":"string"}, - "Facets":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"BucketInfo"} - }, - "FieldValue":{ - "type":"list", - "member":{"shape":"String"} - }, - "Fields":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"FieldValue"} - }, - "FilterQuery":{"type":"string"}, - "Highlight":{"type":"string"}, - "Highlights":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "Hit":{ - "type":"structure", - "members":{ - "id":{ - "shape":"String", - "documentation":"The document ID of a document that matches the search request.
" - }, - "fields":{ - "shape":"Fields", - "documentation":"The fields returned from a document that matches the search request.
" - }, - "highlights":{ - "shape":"Highlights", - "documentation":"The highlights returned from a document that matches the search request.
" - } - }, - "documentation":"Information about a document that matches the search request.
" - }, - "HitList":{ - "type":"list", - "member":{"shape":"Hit"} - }, - "Hits":{ - "type":"structure", - "members":{ - "found":{ - "shape":"Long", - "documentation":"The total number of documents that match the search request.
" - }, - "start":{ - "shape":"Long", - "documentation":"The index of the first matching document.
" - }, - "cursor":{ - "shape":"String", - "documentation":"A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.
" - }, - "hit":{ - "shape":"HitList", - "documentation":"A document that matches the search request.
" - } - }, - "documentation":"The collection of documents that match the search request.
" - }, - "Long":{"type":"long"}, - "Partial":{"type":"boolean"}, - "Query":{"type":"string"}, - "QueryOptions":{"type":"string"}, - "QueryParser":{ - "type":"string", - "enum":[ - "simple", - "structured", - "lucene", - "dismax" - ] - }, - "Return":{"type":"string"}, - "SearchException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"A description of the error returned by the search service.
" - } - }, - "exception":true, - "documentation":"Information about any problems encountered while processing a search request.
" - }, - "SearchRequest":{ - "type":"structure", - "required":["query"], - "members":{ - "cursor":{ - "shape":"Cursor", - "location":"querystring", - "locationName":"cursor", - "documentation":"Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.
For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
" - }, - "expr":{ - "shape":"Expr", - "location":"querystring", - "locationName":"expr", - "documentation":"Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.
For more information about defining and using expressions, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
" - }, - "facet":{ - "shape":"Facet", - "location":"querystring", - "locationName":"facet", - "documentation":"Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.
You can specify the following faceting options:
buckets specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch Developer Guide. Buckets are returned in the order they are specified in the request. The sort and size options are not valid if you specify buckets.
size specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The size parameter is only valid when you specify the sort option; it cannot be used in conjunction with buckets.
sort specifies how you want to sort the facets in the results: bucket or count. Specify bucket to sort alphabetically or numerically by facet value (in ascending order). Specify count to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the buckets option instead of sort.
If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.
" - }, - "filterQuery":{ - "shape":"FilterQuery", - "location":"querystring", - "locationName":"fq", - "documentation":"Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.
For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.
" - }, - "highlight":{ - "shape":"Highlight", - "location":"querystring", - "locationName":"highlight", - "documentation":"Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.
You can specify the following highlight options:
format: specifies the format of the data in the text field: text or html. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is html. max_phrases: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. pre_tag: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is <em>. The default for text highlights is *. post_tag: specifies the string to append to an occurrence of a search term. The default for HTML highlights is </em>. The default for text highlights is *. If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <em>search-term</em>.
Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.
" - }, - "query":{ - "shape":"Query", - "location":"querystring", - "locationName":"q", - "documentation":"Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the queryOptions parameter. By default, the simple query parser is used to process requests. To use the structured, lucene, or dismax query parser, you must also specify the queryParser parameter.
For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.
" - }, - "queryOptions":{ - "shape":"QueryOptions", - "location":"querystring", - "locationName":"q.options", - "documentation":"Configures options for the query parser specified in the queryParser parameter.
The options you can configure vary according to which parser you use:
defaultOperator: The default operator used to combine individual terms in the search string. For example: defaultOperator: 'or'. For the dismax parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of 0% is the equivalent to OR, and a value of 100% is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, defaultOperator: 50%. Valid values: and, or, a percentage in the range 0%-100% (dismax). Default: and (simple, structured, lucene) or 100 (dismax). Valid for: simple, structured, lucene, and dismax.fields: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost the importance of the title field over the description field you could specify: \"fields\":[\"title^5\",\"description\"]. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All text and text-array fields. Valid for: simple, structured, lucene, and dismax.operators: An array of the operators or special characters you want to disable for the simple query parser. If you disable the and, or, or not operators, the corresponding operators (+, |, -) have no special meaning and are dropped from the search string. Similarly, disabling prefix disables the wildcard operator (*) and disabling phrase disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling near disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the fuzzy operator disables the ability to use the ~ operator to perform a fuzzy search. escape disables the ability to use a backslash (\\) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: \"operators\":[\"and\",\"not\",\"or\", \"prefix\"]. Valid values: and, escape, fuzzy, near, not, or, phrase, precedence, prefix, whitespace. Default: All operators and special characters are enabled. Valid for: simple.phraseFields: An array of the text or text-array fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The phraseSlop option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost phrase matches in the title field over the abstract field, you could specify: \"phraseFields\":[\"title^3\", \"plot\"] Valid values: The name of any text or text-array field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with phraseFields, proximity scoring is disabled even if phraseSlop is specified. Valid for: dismax.phraseSlop: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the phraseFields option; for example, phraseSlop: 2. You must also specify phraseFields to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: dismax.explicitPhraseSlop: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify \"explicitPhraseSlop\":3. Valid values: positive integers. Default: 0. Valid for: dismax.tieBreaker: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a tieBreaker value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is (max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields). Set tieBreaker to 0 to disregard all but the highest scoring field (pure max): \"tieBreaker\":0. Set to 1 to sum the scores from all fields (pure sum): \"tieBreaker\":1. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: dismax. Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query parser.
Amazon CloudSearch supports four query parsers:
simple: perform simple searches of text and text-array fields. By default, the simple query parser searches all text and text-array fields. You can specify which fields to search by with the queryOptions parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the queryOptions parameter.) You can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see Searching for Text in the Amazon CloudSearch Developer Guide. structured: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, matchall, and near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer Guide. lucene: search using the Apache Lucene query parser syntax. For more information, see Apache Lucene Query Parser Syntax. dismax: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see DisMax Query Parser Syntax. Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (_all_fields). To return only the document IDs for the matching documents, specify _no_fields. To retrieve the relevance score calculated for each document, specify _score.
Specifies the maximum number of search hits to include in the response.
" - }, - "sort":{ - "shape":"Sort", - "location":"querystring", - "locationName":"sort", - "documentation":"Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (asc or desc) for each field; for example, year desc,title asc. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort parameter is specified, results are sorted by their default relevance scores in descending order: _score desc. You can also sort by document ID (_id asc) and version (_version desc).
For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.
" - }, - "start":{ - "shape":"Start", - "location":"querystring", - "locationName":"start", - "documentation":"Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.
For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
" - } - }, - "documentation":"Container for the parameters to the Search request.
The status information returned for the search request.
" - }, - "hits":{ - "shape":"Hits", - "documentation":"The documents that match the search criteria.
" - }, - "facets":{ - "shape":"Facets", - "documentation":"The requested facet information.
" - } - }, - "documentation":"The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.
How long it took to process the request, in milliseconds.
" - }, - "rid":{ - "shape":"String", - "documentation":"The encrypted resource ID for the request.
" - } - }, - "documentation":"Contains the resource id (rid) and the time it took to process the request (timems).
The query string specified in the suggest request.
" - }, - "found":{ - "shape":"Long", - "documentation":"The number of documents that were found to match the query string.
" - }, - "suggestions":{ - "shape":"Suggestions", - "documentation":"The documents that match the query string.
" - } - }, - "documentation":"Container for the suggestion information returned in a SuggestResponse.
Specifies the string for which you want to get suggestions.
" - }, - "suggester":{ - "shape":"Suggester", - "location":"querystring", - "locationName":"suggester", - "documentation":"Specifies the name of the suggester to use to find suggested matches.
" - }, - "size":{ - "shape":"SuggestionsSize", - "location":"querystring", - "locationName":"size", - "documentation":"Specifies the maximum number of suggestions to return.
" - } - }, - "documentation":"Container for the parameters to the Suggest request.
The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).
Container for the matching search suggestion information.
" - } - }, - "documentation":"Contains the response to a Suggest request.
How long it took to process the request, in milliseconds.
" - }, - "rid":{ - "shape":"String", - "documentation":"The encrypted resource ID for the request.
" - } - }, - "documentation":"Contains the resource id (rid) and the time it took to process the request (timems).
The string that matches the query string specified in the SuggestRequest.
The relevance score of a suggested match.
" - }, - "id":{ - "shape":"String", - "documentation":"The document ID of the suggested document.
" - } - }, - "documentation":"An autocomplete suggestion that matches the query string specified in a SuggestRequest.
A batch of documents formatted in JSON or HTML.
" - }, - "contentType":{ - "shape":"ContentType", - "location":"header", - "locationName":"Content-Type", - "documentation":"The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
Container for the parameters to the UploadDocuments request.
The status of an UploadDocumentsRequest.
The number of documents that were added to the search domain.
" - }, - "deletes":{ - "shape":"Deletes", - "documentation":"The number of documents that were deleted from the search domain.
" - }, - "warnings":{ - "shape":"DocumentServiceWarnings", - "documentation":"Any warnings returned by the document service about the documents being uploaded.
" - } - }, - "documentation":"Contains the response to an UploadDocuments request.
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
", - "operations":{ - "CreateTrail":{ - "name":"CreateTrail", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateTrailRequest", - "documentation":"Specifies the settings for each trail.
" - }, - "output":{ - "shape":"CreateTrailResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." - }, - "errors":[ - { - "shape":"MaximumNumberOfTrailsExceededException", - "error":{ - "code":"MaximumNumberOfTrailsExceeded", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the maximum number of trails is reached." - }, - { - "shape":"TrailAlreadyExistsException", - "error":{ - "code":"TrailAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the specified trail already exists." - }, - { - "shape":"S3BucketDoesNotExistException", - "error":{ - "code":"S3BucketDoesNotExist", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the specified S3 bucket does not exist." - }, - { - "shape":"InsufficientS3BucketPolicyException", - "error":{ - "code":"InsufficientS3BucketPolicy", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the policy on the S3 bucket is not sufficient." - }, - { - "shape":"InsufficientSnsTopicPolicyException", - "error":{ - "code":"InsufficientSnsTopicPolicy", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the policy on the SNS topic is not sufficient." - }, - { - "shape":"InvalidS3BucketNameException", - "error":{ - "code":"InvalidS3BucketName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided S3 bucket name is not valid." - }, - { - "shape":"InvalidS3PrefixException", - "error":{ - "code":"InvalidS3Prefix", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided S3 prefix is not valid." - }, - { - "shape":"InvalidSnsTopicNameException", - "error":{ - "code":"InvalidSnsTopicName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided SNS topic name is not valid." - }, - { - "shape":"InvalidTrailNameException", - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - }, - { - "shape":"InvalidCloudWatchLogsLogGroupArnException", - "error":{ - "code":"InvalidCloudWatchLogsLogGroupArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided CloudWatch log group is not valid." - }, - { - "shape":"InvalidCloudWatchLogsRoleArnException", - "error":{ - "code":"InvalidCloudWatchLogsRoleArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided role is not valid." - }, - { - "shape":"CloudWatchLogsDeliveryUnavailableException", - "error":{ - "code":"CloudWatchLogsDeliveryUnavailable", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot set a CloudWatch Logs delivery for this region." - } - ], - "documentation":"From the command line, use create-subscription.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
" - }, - "DeleteTrail":{ - "name":"DeleteTrail", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteTrailRequest", - "documentation":"The request that specifies the name of a trail to delete." - }, - "output":{ - "shape":"DeleteTrailResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "errors":[ - { - "shape":"TrailNotFoundException", - "error":{ - "code":"TrailNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the trail with the given name is not found." - }, - { - "shape":"InvalidTrailNameException", - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - } - ], - "documentation":"Deletes a trail.
" - }, - "DescribeTrails":{ - "name":"DescribeTrails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeTrailsRequest", - "documentation":"Returns information about the trail.
" - }, - "output":{ - "shape":"DescribeTrailsResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "documentation":"Retrieves settings for the trail associated with the current region for your account.
" - }, - "GetTrailStatus":{ - "name":"GetTrailStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetTrailStatusRequest", - "documentation":"The name of a trail about which you want the current status.
" - }, - "output":{ - "shape":"GetTrailStatusResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "errors":[ - { - "shape":"TrailNotFoundException", - "error":{ - "code":"TrailNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the trail with the given name is not found." - }, - { - "shape":"InvalidTrailNameException", - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - } - ], - "documentation":"Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail.
" - }, - "StartLogging":{ - "name":"StartLogging", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"StartLoggingRequest", - "documentation":"The request to CloudTrail to start logging AWS API calls for an account.
" - }, - "output":{ - "shape":"StartLoggingResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "errors":[ - { - "shape":"TrailNotFoundException", - "error":{ - "code":"TrailNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the trail with the given name is not found." - }, - { - "shape":"InvalidTrailNameException", - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - } - ], - "documentation":"Starts the recording of AWS API calls and log file delivery for a trail.
" - }, - "StopLogging":{ - "name":"StopLogging", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"StopLoggingRequest", - "documentation":"Passes the request to CloudTrail to stop logging AWS API calls for the specified account.
" - }, - "output":{ - "shape":"StopLoggingResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "errors":[ - { - "shape":"TrailNotFoundException", - "error":{ - "code":"TrailNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the trail with the given name is not found." - }, - { - "shape":"InvalidTrailNameException", - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - } - ], - "documentation":"Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording.
" - }, - "UpdateTrail":{ - "name":"UpdateTrail", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateTrailRequest", - "documentation":"Specifies settings to update for the trail.
" - }, - "output":{ - "shape":"UpdateTrailResponse", - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." - }, - "errors":[ - { - "shape":"S3BucketDoesNotExistException", - "error":{ - "code":"S3BucketDoesNotExist", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the specified S3 bucket does not exist." - }, - { - "shape":"InsufficientS3BucketPolicyException", - "error":{ - "code":"InsufficientS3BucketPolicy", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the policy on the S3 bucket is not sufficient." - }, - { - "shape":"InsufficientSnsTopicPolicyException", - "error":{ - "code":"InsufficientSnsTopicPolicy", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the policy on the SNS topic is not sufficient." - }, - { - "shape":"TrailNotFoundException", - "error":{ - "code":"TrailNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the trail with the given name is not found." - }, - { - "shape":"InvalidS3BucketNameException", - "error":{ - "code":"InvalidS3BucketName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided S3 bucket name is not valid." - }, - { - "shape":"InvalidS3PrefixException", - "error":{ - "code":"InvalidS3Prefix", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided S3 prefix is not valid." - }, - { - "shape":"InvalidSnsTopicNameException", - "error":{ - "code":"InvalidSnsTopicName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided SNS topic name is not valid." - }, - { - "shape":"InvalidTrailNameException", - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - }, - { - "shape":"InvalidCloudWatchLogsLogGroupArnException", - "error":{ - "code":"InvalidCloudWatchLogsLogGroupArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided CloudWatch log group is not valid." - }, - { - "shape":"InvalidCloudWatchLogsRoleArnException", - "error":{ - "code":"InvalidCloudWatchLogsRoleArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided role is not valid." - }, - { - "shape":"CloudWatchLogsDeliveryUnavailableException", - "error":{ - "code":"CloudWatchLogsDeliveryUnavailable", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot set a CloudWatch Logs delivery for this region." - } - ], - "documentation":"From the command line, use update-subscription.
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket.
" - } - }, - "shapes":{ - "Boolean":{"type":"boolean"}, - "CloudWatchLogsDeliveryUnavailableException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CloudWatchLogsDeliveryUnavailable", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot set a CloudWatch Logs delivery for this region." - }, - "CreateTrailRequest":{ - "type":"structure", - "required":[ - "Name", - "S3BucketName" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"Specifies the name of the trail.
" - }, - "S3BucketName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon S3 bucket designated for publishing log files.
" - }, - "S3KeyPrefix":{ - "shape":"String", - "documentation":"Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
" - }, - "SnsTopicName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
" - }, - "IncludeGlobalServiceEvents":{ - "shape":"Boolean", - "documentation":"Specifies whether the trail is publishing events from global services such as IAM to the log files.
" - }, - "CloudWatchLogsLogGroupArn":{ - "shape":"String", - "documentation":"Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
" - }, - "CloudWatchLogsRoleArn":{ - "shape":"String", - "documentation":"Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
" - } - }, - "documentation":"Specifies the settings for each trail.
" - }, - "CreateTrailResponse":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"Specifies the name of the trail.
" - }, - "S3BucketName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon S3 bucket designated for publishing log files.
" - }, - "S3KeyPrefix":{ - "shape":"String", - "documentation":"Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
" - }, - "SnsTopicName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
" - }, - "IncludeGlobalServiceEvents":{ - "shape":"Boolean", - "documentation":"Specifies whether the trail is publishing events from global services such as IAM to the log files.
" - }, - "CloudWatchLogsLogGroupArn":{ - "shape":"String", - "documentation":"Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
" - }, - "CloudWatchLogsRoleArn":{ - "shape":"String", - "documentation":"Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
" - } - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." - }, - "Date":{"type":"timestamp"}, - "DeleteTrailRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of a trail to be deleted.
" - } - }, - "documentation":"The request that specifies the name of a trail to delete." - }, - "DeleteTrailResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "DescribeTrailsRequest":{ - "type":"structure", - "members":{ - "trailNameList":{ - "shape":"TrailNameList", - "documentation":"The trail returned.
" - } - }, - "documentation":"Returns information about the trail.
" - }, - "DescribeTrailsResponse":{ - "type":"structure", - "members":{ - "trailList":{ - "shape":"TrailList", - "documentation":"The list of trails.
" - } - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "GetTrailStatusRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the trail for which you are requesting the current status.
" - } - }, - "documentation":"The name of a trail about which you want the current status.
" - }, - "GetTrailStatusResponse":{ - "type":"structure", - "members":{ - "IsLogging":{ - "shape":"Boolean", - "documentation":"Whether the CloudTrail is currently logging AWS API calls.
" - }, - "LatestDeliveryError":{ - "shape":"String", - "documentation":"Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.
" - }, - "LatestNotificationError":{ - "shape":"String", - "documentation":"Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.
" - }, - "LatestDeliveryTime":{ - "shape":"Date", - "documentation":"Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
" - }, - "LatestNotificationTime":{ - "shape":"Date", - "documentation":"Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.
" - }, - "StartLoggingTime":{ - "shape":"Date", - "documentation":"Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
" - }, - "StopLoggingTime":{ - "shape":"Date", - "documentation":"Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
" - }, - "LatestCloudWatchLogsDeliveryError":{ - "shape":"String", - "documentation":"Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
" - }, - "LatestCloudWatchLogsDeliveryTime":{ - "shape":"Date", - "documentation":"Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
" - } - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "InsufficientS3BucketPolicyException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientS3BucketPolicy", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the policy on the S3 bucket is not sufficient." - }, - "InsufficientSnsTopicPolicyException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientSnsTopicPolicy", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the policy on the SNS topic is not sufficient." - }, - "InvalidCloudWatchLogsLogGroupArnException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidCloudWatchLogsLogGroupArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided CloudWatch log group is not valid." - }, - "InvalidCloudWatchLogsRoleArnException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidCloudWatchLogsRoleArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided role is not valid." - }, - "InvalidS3BucketNameException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidS3BucketName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided S3 bucket name is not valid." - }, - "InvalidS3PrefixException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidS3Prefix", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided S3 prefix is not valid." - }, - "InvalidSnsTopicNameException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSnsTopicName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided SNS topic name is not valid." - }, - "InvalidTrailNameException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidTrailName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the provided trail name is not valid." - }, - "MaximumNumberOfTrailsExceededException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"MaximumNumberOfTrailsExceeded", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the maximum number of trails is reached." - }, - "S3BucketDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"S3BucketDoesNotExist", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the specified S3 bucket does not exist." - }, - "StartLoggingRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the trail for which CloudTrail logs AWS API calls.
" - } - }, - "documentation":"The request to CloudTrail to start logging AWS API calls for an account.
" - }, - "StartLoggingResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "StopLoggingRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "documentation":"Communicates to CloudTrail the name of the trail for which to stop logging AWS API calls.
" - } - }, - "documentation":"Passes the request to CloudTrail to stop logging AWS API calls for the specified account.
" - }, - "StopLoggingResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error.
" - }, - "String":{"type":"string"}, - "Trail":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"Name of the trail set by calling CreateTrail.
" - }, - "S3BucketName":{ - "shape":"String", - "documentation":"Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
" - }, - "S3KeyPrefix":{ - "shape":"String", - "documentation":"Value of the Amazon S3 prefix.
" - }, - "SnsTopicName":{ - "shape":"String", - "documentation":"Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
" - }, - "IncludeGlobalServiceEvents":{ - "shape":"Boolean", - "documentation":"Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
" - }, - "CloudWatchLogsLogGroupArn":{ - "shape":"String", - "documentation":"Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
" - }, - "CloudWatchLogsRoleArn":{ - "shape":"String", - "documentation":"Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
" - } - }, - "documentation":"The settings for a trail.
" - }, - "TrailAlreadyExistsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TrailAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the specified trail already exists." - }, - "TrailList":{ - "type":"list", - "member":{"shape":"Trail"} - }, - "TrailNameList":{ - "type":"list", - "member":{"shape":"String"} - }, - "TrailNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TrailNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"This exception is thrown when the trail with the given name is not found." - }, - "UpdateTrailRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "documentation":"Specifies the name of the trail.
" - }, - "S3BucketName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon S3 bucket designated for publishing log files.
" - }, - "S3KeyPrefix":{ - "shape":"String", - "documentation":"Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
" - }, - "SnsTopicName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
" - }, - "IncludeGlobalServiceEvents":{ - "shape":"Boolean", - "documentation":"Specifies whether the trail is publishing events from global services such as IAM to the log files.
" - }, - "CloudWatchLogsLogGroupArn":{ - "shape":"String", - "documentation":"Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
" - }, - "CloudWatchLogsRoleArn":{ - "shape":"String", - "documentation":"Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
" - } - }, - "documentation":"Specifies settings to update for the trail.
" - }, - "UpdateTrailResponse":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"Specifies the name of the trail.
" - }, - "S3BucketName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon S3 bucket designated for publishing log files.
" - }, - "S3KeyPrefix":{ - "shape":"String", - "documentation":"Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.
" - }, - "SnsTopicName":{ - "shape":"String", - "documentation":"Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
" - }, - "IncludeGlobalServiceEvents":{ - "shape":"Boolean", - "documentation":"Specifies whether the trail is publishing events from global services such as IAM to the log files.
" - }, - "CloudWatchLogsLogGroupArn":{ - "shape":"String", - "documentation":"Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
" - }, - "CloudWatchLogsRoleArn":{ - "shape":"String", - "documentation":"Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.
" - } - }, - "documentation":"Returns the objects or data listed below if successful. Otherwise, returns an error." - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cloudwatch/2010-08-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cloudwatch/2010-08-01.normal.json deleted file mode 100644 index 6a365fcbef..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cloudwatch/2010-08-01.normal.json +++ /dev/null @@ -1,1338 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-08-01", - "endpointPrefix":"monitoring", - "serviceAbbreviation":"CloudWatch", - "serviceFullName":"Amazon CloudWatch", - "signatureVersion":"v4", - "xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/", - "protocol":"query" - }, - "documentation":"This is the Amazon CloudWatch API Reference. This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch.
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
Use the following links to get started using the Amazon CloudWatch API Reference:
In addition to using the Amazon CloudWatch API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch programmatically.
Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:
The named resource does not exist.
" - } - ], - "documentation":"Deletes all specified alarms. In the event of an error, no alarms are deleted.
" - }, - "DescribeAlarmHistory":{ - "name":"DescribeAlarmHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAlarmHistoryInput"}, - "output":{ - "shape":"DescribeAlarmHistoryOutput", - "documentation":"The output for the DescribeAlarmHistory action.
", - "resultWrapper":"DescribeAlarmHistoryResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The next token specified is invalid.
" - } - ], - "documentation":"Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
" - }, - "DescribeAlarms":{ - "name":"DescribeAlarms", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAlarmsInput"}, - "output":{ - "shape":"DescribeAlarmsOutput", - "documentation":"The output for the DescribeAlarms action.
", - "resultWrapper":"DescribeAlarmsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The next token specified is invalid.
" - } - ], - "documentation":"Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
" - }, - "DescribeAlarmsForMetric":{ - "name":"DescribeAlarmsForMetric", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAlarmsForMetricInput"}, - "output":{ - "shape":"DescribeAlarmsForMetricOutput", - "documentation":"The output for the DescribeAlarmsForMetric action.
", - "resultWrapper":"DescribeAlarmsForMetricResult" - }, - "documentation":"Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
" - }, - "DisableAlarmActions":{ - "name":"DisableAlarmActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DisableAlarmActionsInput", - "documentation":"" - }, - "documentation":"
Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
" - }, - "EnableAlarmActions":{ - "name":"EnableAlarmActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableAlarmActionsInput"}, - "documentation":"Enables actions for the specified alarms.
" - }, - "GetMetricStatistics":{ - "name":"GetMetricStatistics", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetMetricStatisticsInput"}, - "output":{ - "shape":"GetMetricStatisticsOutput", - "documentation":"The output for the GetMetricStatistics action.
", - "resultWrapper":"GetMetricStatisticsResult" - }, - "errors":[ - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Bad or out-of-range value was supplied for the input parameter.
" - }, - { - "shape":"MissingRequiredParameterException", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An input parameter that is mandatory for processing the request is not supplied.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Parameters that must not be used together were used together.
" - }, - { - "shape":"InternalServiceFault", - "error":{ - "code":"InternalServiceError", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that the request processing has failed due to some unknown error, exception, or failure.
", - "xmlOrder":["Message"] - } - ], - "documentation":"Gets statistics for the specified metric.
The maximum number of data points returned from a single GetMetricStatistics request is 1,440, wereas the maximum number of data points that can be queried is 50,850. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges.
Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned.
The following examples show various statistics allowed by the data point query maximum of 50,850 when you call GetMetricStatistics on Amazon EC2 instances with detailed (one-minute) monitoring enabled:
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
" - }, - "ListMetrics":{ - "name":"ListMetrics", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListMetricsInput"}, - "output":{ - "shape":"ListMetricsOutput", - "documentation":"The output for the ListMetrics action.
", - "xmlOrder":[ - "Metrics", - "NextToken" - ], - "resultWrapper":"ListMetricsResult" - }, - "errors":[ - { - "shape":"InternalServiceFault", - "error":{ - "code":"InternalServiceError", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that the request processing has failed due to some unknown error, exception, or failure.
", - "xmlOrder":["Message"] - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Bad or out-of-range value was supplied for the input parameter.
" - } - ], - "documentation":"Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.
" - }, - "PutMetricAlarm":{ - "name":"PutMetricAlarm", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutMetricAlarmInput"}, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for alarms for this customer has already been reached.
" - } - ], - "documentation":"Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.
Bad or out-of-range value was supplied for the input parameter.
" - }, - { - "shape":"MissingRequiredParameterException", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An input parameter that is mandatory for processing the request is not supplied.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Parameters that must not be used together were used together.
" - }, - { - "shape":"InternalServiceFault", - "error":{ - "code":"InternalServiceError", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that the request processing has failed due to some unknown error, exception, or failure.
", - "xmlOrder":["Message"] - } - ], - "documentation":"Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. It can take up to fifteen minutes for a new metric to appear in calls to the ListMetrics action.
The size of a
Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.
The named resource does not exist.
" - }, - { - "shape":"InvalidFormatFault", - "error":{ - "code":"InvalidFormat", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Data was not syntactically valid JSON.
" - } - ], - "documentation":" Temporarily sets the state of an alarm. When the updated StateValue differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state.
The descriptive name for the alarm.
" - }, - "Timestamp":{ - "shape":"Timestamp", - "documentation":"The time stamp for the alarm history item. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.
" - }, - "HistoryItemType":{ - "shape":"HistoryItemType", - "documentation":"The type of alarm history item.
" - }, - "HistorySummary":{ - "shape":"HistorySummary", - "documentation":"A human-readable summary of the alarm history.
" - }, - "HistoryData":{ - "shape":"HistoryData", - "documentation":"Machine-readable data about the alarm in JSON format.
" - } - }, - "documentation":" The AlarmHistoryItem data type contains descriptive information about the history of a specific alarm. If you call DescribeAlarmHistory, Amazon CloudWatch returns this data type as part of the DescribeAlarmHistoryResult data type.
The time stamp used for the datapoint. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.
" - }, - "SampleCount":{ - "shape":"DatapointValue", - "documentation":"The number of metric values that contributed to the aggregate value of this datapoint.
" - }, - "Average":{ - "shape":"DatapointValue", - "documentation":"The average of metric values that correspond to the datapoint.
" - }, - "Sum":{ - "shape":"DatapointValue", - "documentation":"The sum of metric values used for the datapoint.
" - }, - "Minimum":{ - "shape":"DatapointValue", - "documentation":"The minimum metric value used for the datapoint.
" - }, - "Maximum":{ - "shape":"DatapointValue", - "documentation":"The maximum of the metric value used for the datapoint.
" - }, - "Unit":{ - "shape":"StandardUnit", - "documentation":"The standard unit used for the datapoint.
" - } - }, - "documentation":" The Datapoint data type encapsulates the statistical data that Amazon CloudWatch computes from metric data.
A list of alarms to be deleted.
" - } - } - }, - "DescribeAlarmHistoryInput":{ - "type":"structure", - "members":{ - "AlarmName":{ - "shape":"AlarmName", - "documentation":"The name of the alarm.
" - }, - "HistoryItemType":{ - "shape":"HistoryItemType", - "documentation":"The type of alarm histories to retrieve.
" - }, - "StartDate":{ - "shape":"Timestamp", - "documentation":"The starting date to retrieve alarm history.
" - }, - "EndDate":{ - "shape":"Timestamp", - "documentation":"The ending date to retrieve alarm history.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of alarm history records to retrieve.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The token returned by a previous call to indicate that there is more data available.
" - } - } - }, - "DescribeAlarmHistoryOutput":{ - "type":"structure", - "members":{ - "AlarmHistoryItems":{ - "shape":"AlarmHistoryItems", - "documentation":"A list of alarm histories in JSON format.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":"The output for the DescribeAlarmHistory action.
" - }, - "DescribeAlarmsForMetricInput":{ - "type":"structure", - "required":[ - "MetricName", - "Namespace" - ], - "members":{ - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the metric.
" - }, - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace of the metric.
" - }, - "Statistic":{ - "shape":"Statistic", - "documentation":"The statistic for the metric.
" - }, - "Dimensions":{ - "shape":"Dimensions", - "documentation":"The list of dimensions associated with the metric.
" - }, - "Period":{ - "shape":"Period", - "documentation":"The period in seconds over which the statistic is applied.
" - }, - "Unit":{ - "shape":"StandardUnit", - "documentation":"The unit for the metric.
" - } - } - }, - "DescribeAlarmsForMetricOutput":{ - "type":"structure", - "members":{ - "MetricAlarms":{ - "shape":"MetricAlarms", - "documentation":"A list of information for each alarm with the specified metric.
" - } - }, - "documentation":"The output for the DescribeAlarmsForMetric action.
" - }, - "DescribeAlarmsInput":{ - "type":"structure", - "members":{ - "AlarmNames":{ - "shape":"AlarmNames", - "documentation":"A list of alarm names to retrieve information for.
" - }, - "AlarmNamePrefix":{ - "shape":"AlarmNamePrefix", - "documentation":" The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
The state value to be used in matching alarms.
" - }, - "ActionPrefix":{ - "shape":"ActionPrefix", - "documentation":"The action name prefix.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of alarm descriptions to retrieve.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The token returned by a previous call to indicate that there is more data available.
" - } - } - }, - "DescribeAlarmsOutput":{ - "type":"structure", - "members":{ - "MetricAlarms":{ - "shape":"MetricAlarms", - "documentation":"A list of information for the specified alarms.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":"The output for the DescribeAlarms action.
" - }, - "Dimension":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"DimensionName", - "documentation":"The name of the dimension.
" - }, - "Value":{ - "shape":"DimensionValue", - "documentation":"The value representing the dimension measurement
" - } - }, - "documentation":" The Dimension data type further expands on the identity of a metric using a Name, Value pair.
For examples that use one or more dimensions, see PutMetricData.
", - "xmlOrder":[ - "Name", - "Value" - ] - }, - "DimensionFilter":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"DimensionName", - "documentation":"The dimension name to be matched.
" - }, - "Value":{ - "shape":"DimensionValue", - "documentation":"The value of the dimension to be matched.
" - } - }, - "documentation":" The DimensionFilter data type is used to filter ListMetrics results.
The names of the alarms to disable actions for.
" - } - }, - "documentation":"" - }, - "EnableAlarmActionsInput":{ - "type":"structure", - "required":["AlarmNames"], - "members":{ - "AlarmNames":{ - "shape":"AlarmNames", - "documentation":"
The names of the alarms to enable actions for.
" - } - } - }, - "ErrorMessage":{ - "type":"string", - "min":1, - "max":255 - }, - "EvaluationPeriods":{ - "type":"integer", - "min":1 - }, - "FaultDescription":{"type":"string"}, - "GetMetricStatisticsInput":{ - "type":"structure", - "required":[ - "Namespace", - "MetricName", - "StartTime", - "EndTime", - "Period", - "Statistics" - ], - "members":{ - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace of the metric, with or without spaces.
" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the metric, with or without spaces.
" - }, - "Dimensions":{ - "shape":"Dimensions", - "documentation":"A list of dimensions describing qualities of the metric.
" - }, - "StartTime":{ - "shape":"Timestamp", - "documentation":"The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified.
" - }, - "EndTime":{ - "shape":"Timestamp", - "documentation":"The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified.
" - }, - "Period":{ - "shape":"Period", - "documentation":" The granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default value is 60.
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, go to Statistics in the Amazon CloudWatch Developer Guide.
Valid Values: Average | Sum | SampleCount | Maximum | Minimum
The unit for the metric.
" - } - } - }, - "GetMetricStatisticsOutput":{ - "type":"structure", - "members":{ - "Label":{ - "shape":"MetricLabel", - "documentation":"A label describing the specified metric.
" - }, - "Datapoints":{ - "shape":"Datapoints", - "documentation":"The datapoints for the specified metric.
" - } - }, - "documentation":"The output for the GetMetricStatistics action.
" - }, - "HistoryData":{ - "type":"string", - "min":1, - "max":4095 - }, - "HistoryItemType":{ - "type":"string", - "enum":[ - "ConfigurationUpdate", - "StateUpdate", - "Action" - ] - }, - "HistorySummary":{ - "type":"string", - "min":1, - "max":255 - }, - "InternalServiceFault":{ - "type":"structure", - "members":{ - "Message":{ - "shape":"FaultDescription", - "documentation":"" - } - }, - "error":{ - "code":"InternalServiceError", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that the request processing has failed due to some unknown error, exception, or failure.
", - "xmlOrder":["Message"] - }, - "InvalidFormatFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"" - } - }, - "error":{ - "code":"InvalidFormat", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Data was not syntactically valid JSON.
" - }, - "InvalidNextToken":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"" - } - }, - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The next token specified is invalid.
" - }, - "InvalidParameterCombinationException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"AwsQueryErrorMessage", - "documentation":"" - } - }, - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Parameters that must not be used together were used together.
" - }, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"AwsQueryErrorMessage", - "documentation":"" - } - }, - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Bad or out-of-range value was supplied for the input parameter.
" - }, - "LimitExceededFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"" - } - }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for alarms for this customer has already been reached.
" - }, - "ListMetricsInput":{ - "type":"structure", - "members":{ - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace to filter against.
" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the metric to filter against.
" - }, - "Dimensions":{ - "shape":"DimensionFilters", - "documentation":"A list of dimensions to filter against.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The token returned by a previous call to indicate that there is more data available.
" - } - } - }, - "ListMetricsOutput":{ - "type":"structure", - "members":{ - "Metrics":{ - "shape":"Metrics", - "documentation":"A list of metrics used to generate statistics for an AWS account.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":"The output for the ListMetrics action.
", - "xmlOrder":[ - "Metrics", - "NextToken" - ] - }, - "MaxRecords":{ - "type":"integer", - "min":1, - "max":100 - }, - "Metric":{ - "type":"structure", - "members":{ - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace of the metric.
" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the metric.
" - }, - "Dimensions":{ - "shape":"Dimensions", - "documentation":"A list of dimensions associated with the metric.
" - } - }, - "documentation":" The Metric data type contains information about a specific metric. If you call ListMetrics, Amazon CloudWatch returns information contained by this data type.
The example in the Examples section publishes two metrics named buffers and latency. Both metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType.
", - "xmlOrder":[ - "Namespace", - "MetricName", - "Dimensions" - ] - }, - "MetricAlarm":{ - "type":"structure", - "members":{ - "AlarmName":{ - "shape":"AlarmName", - "documentation":"The name of the alarm.
" - }, - "AlarmArn":{ - "shape":"AlarmArn", - "documentation":"The Amazon Resource Name (ARN) of the alarm.
" - }, - "AlarmDescription":{ - "shape":"AlarmDescription", - "documentation":"The description for the alarm.
" - }, - "AlarmConfigurationUpdatedTimestamp":{ - "shape":"Timestamp", - "documentation":"The time stamp of the last update to the alarm configuration. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.
" - }, - "ActionsEnabled":{ - "shape":"ActionsEnabled", - "documentation":"Indicates whether actions should be executed during any changes to the alarm's state.
" - }, - "OKActions":{ - "shape":"ResourceList", - "documentation":" The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.
UnknownActions.The state value for the alarm.
" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"A human-readable explanation for the alarm's state.
" - }, - "StateReasonData":{ - "shape":"StateReasonData", - "documentation":"An explanation for the alarm's state in machine-readable JSON format
" - }, - "StateUpdatedTimestamp":{ - "shape":"Timestamp", - "documentation":"The time stamp of the last update to the alarm's state. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.
" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the alarm's metric.
" - }, - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace of alarm's associated metric.
" - }, - "Statistic":{ - "shape":"Statistic", - "documentation":"The statistic to apply to the alarm's associated metric.
" - }, - "Dimensions":{ - "shape":"Dimensions", - "documentation":"The list of dimensions associated with the alarm's associated metric.
" - }, - "Period":{ - "shape":"Period", - "documentation":"The period in seconds over which the statistic is applied.
" - }, - "Unit":{ - "shape":"StandardUnit", - "documentation":"The unit of the alarm's associated metric.
" - }, - "EvaluationPeriods":{ - "shape":"EvaluationPeriods", - "documentation":"The number of periods over which data is compared to the specified threshold.
" - }, - "Threshold":{ - "shape":"Threshold", - "documentation":"The value against which the specified statistic is compared.
" - }, - "ComparisonOperator":{ - "shape":"ComparisonOperator", - "documentation":" The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.
", - "xmlOrder":[ - "AlarmName", - "AlarmArn", - "AlarmDescription", - "AlarmConfigurationUpdatedTimestamp", - "ActionsEnabled", - "OKActions", - "AlarmActions", - "InsufficientDataActions", - "StateValue", - "StateReason", - "StateReasonData", - "StateUpdatedTimestamp", - "MetricName", - "Namespace", - "Statistic", - "Dimensions", - "Period", - "Unit", - "EvaluationPeriods", - "Threshold", - "ComparisonOperator" - ] - }, - "MetricAlarms":{ - "type":"list", - "member":{"shape":"MetricAlarm"} - }, - "MetricData":{ - "type":"list", - "member":{"shape":"MetricDatum"} - }, - "MetricDatum":{ - "type":"structure", - "required":["MetricName"], - "members":{ - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the metric.
" - }, - "Dimensions":{ - "shape":"Dimensions", - "documentation":"A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).
" - }, - "Timestamp":{ - "shape":"Timestamp", - "documentation":"The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received. Amazon CloudWatch uses Coordinated Universal Time (UTC) when returning time stamps, which do not accommodate seasonal adjustments such as daylight savings time. For more information, see Time stamps in the Amazon CloudWatch Developer Guide.
" - }, - "Value":{ - "shape":"DatapointValue", - "documentation":"The value for the metric.
Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. A set of statistical values describing the metric.
" - }, - "Unit":{ - "shape":"StandardUnit", - "documentation":"The unit of the metric.
" - } - }, - "documentation":" The MetricDatum data type encapsulates the information sent with PutMetricData to either create a new metric or add new values to be aggregated into an existing metric.
An input parameter that is mandatory for processing the request is not supplied.
" - }, - "Namespace":{ - "type":"string", - "min":1, - "max":255, - "pattern":"[^:].*" - }, - "NextToken":{"type":"string"}, - "Period":{ - "type":"integer", - "min":60 - }, - "PutMetricAlarmInput":{ - "type":"structure", - "required":[ - "AlarmName", - "MetricName", - "Namespace", - "Statistic", - "Period", - "EvaluationPeriods", - "Threshold", - "ComparisonOperator" - ], - "members":{ - "AlarmName":{ - "shape":"AlarmName", - "documentation":"The descriptive name for the alarm. This name must be unique within the user's AWS account
" - }, - "AlarmDescription":{ - "shape":"AlarmDescription", - "documentation":"The description for the alarm.
" - }, - "ActionsEnabled":{ - "shape":"ActionsEnabled", - "documentation":"Indicates whether or not actions should be executed during any changes to the alarm's state.
" - }, - "OKActions":{ - "shape":"ResourceList", - "documentation":" The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
The name for the alarm's associated metric.
" - }, - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace for the alarm's associated metric.
" - }, - "Statistic":{ - "shape":"Statistic", - "documentation":"The statistic to apply to the alarm's associated metric.
" - }, - "Dimensions":{ - "shape":"Dimensions", - "documentation":"The dimensions for the alarm's associated metric.
" - }, - "Period":{ - "shape":"Period", - "documentation":"The period in seconds over which the specified statistic is applied.
" - }, - "Unit":{ - "shape":"StandardUnit", - "documentation":"The unit for the alarm's associated metric.
" - }, - "EvaluationPeriods":{ - "shape":"EvaluationPeriods", - "documentation":"The number of periods over which data is compared to the specified threshold.
" - }, - "Threshold":{ - "shape":"Threshold", - "documentation":"The value against which the specified statistic is compared.
" - }, - "ComparisonOperator":{ - "shape":"ComparisonOperator", - "documentation":" The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
The namespace for the metric data.
" - }, - "MetricData":{ - "shape":"MetricData", - "documentation":"A list of data describing the metric.
" - } - } - }, - "ResourceList":{ - "type":"list", - "member":{"shape":"ResourceName"}, - "max":5 - }, - "ResourceName":{ - "type":"string", - "min":1, - "max":1024 - }, - "ResourceNotFound":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"" - } - }, - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The named resource does not exist.
" - }, - "SetAlarmStateInput":{ - "type":"structure", - "required":[ - "AlarmName", - "StateValue", - "StateReason" - ], - "members":{ - "AlarmName":{ - "shape":"AlarmName", - "documentation":"The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
" - }, - "StateValue":{ - "shape":"StateValue", - "documentation":"The value of the state.
" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"The reason that this alarm is set to this specific state (in human-readable text format)
" - }, - "StateReasonData":{ - "shape":"StateReasonData", - "documentation":"The reason that this alarm is set to this specific state (in machine-readable JSON format)
" - } - } - }, - "StandardUnit":{ - "type":"string", - "enum":[ - "Seconds", - "Microseconds", - "Milliseconds", - "Bytes", - "Kilobytes", - "Megabytes", - "Gigabytes", - "Terabytes", - "Bits", - "Kilobits", - "Megabits", - "Gigabits", - "Terabits", - "Percent", - "Count", - "Bytes/Second", - "Kilobytes/Second", - "Megabytes/Second", - "Gigabytes/Second", - "Terabytes/Second", - "Bits/Second", - "Kilobits/Second", - "Megabits/Second", - "Gigabits/Second", - "Terabits/Second", - "Count/Second", - "None" - ] - }, - "StateReason":{ - "type":"string", - "min":0, - "max":1023 - }, - "StateReasonData":{ - "type":"string", - "min":0, - "max":4000 - }, - "StateValue":{ - "type":"string", - "enum":[ - "OK", - "ALARM", - "INSUFFICIENT_DATA" - ] - }, - "Statistic":{ - "type":"string", - "enum":[ - "SampleCount", - "Average", - "Sum", - "Minimum", - "Maximum" - ] - }, - "StatisticSet":{ - "type":"structure", - "required":[ - "SampleCount", - "Sum", - "Minimum", - "Maximum" - ], - "members":{ - "SampleCount":{ - "shape":"DatapointValue", - "documentation":"The number of samples used for the statistic set.
" - }, - "Sum":{ - "shape":"DatapointValue", - "documentation":"The sum of values for the sample set.
" - }, - "Minimum":{ - "shape":"DatapointValue", - "documentation":"The minimum value of the sample set.
" - }, - "Maximum":{ - "shape":"DatapointValue", - "documentation":"The maximum value of the sample set.
" - } - }, - "documentation":" The StatisticSet data type describes the StatisticValues component of MetricDatum, and represents a set of statistics that describes a specific metric.
This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the AWS CodeDeploy User Guide.
Using the APIsYou can use the AWS CodeDeploy APIs to work with the following items:
Applications, which are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.
You can work with applications by calling CreateApplication, DeleteApplication, GetApplication, ListApplications, BatchGetApplications, and UpdateApplication to create, delete, and get information about applications, and to change information about an application, respectively.
Deployment configurations, which are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments.
You can work with deployment configurations by calling CreateDeploymentConfig, DeleteDeploymentConfig, GetDeploymentConfig, and ListDeploymentConfigs to create, delete, and get information about deployment configurations, respectively.
Deployment groups, which represent groups of Amazon EC2 instances to which application revisions can be deployed.
You can work with deployment groups by calling CreateDeploymentGroup, DeleteDeploymentGroup, GetDeploymentGroup, ListDeploymentGroups, and UpdateDeploymentGroup to create, delete, and get information about single and multiple deployment groups, and to change information about a deployment group, respectively.
Deployment instances (also known simply as instances), which represent Amazon EC2 instances to which application revisions are deployed. Deployment instances are identified by their Amazon EC2 tags or Auto Scaling group names. Deployment instances belong to deployment groups.
You can work with deployment instances by calling GetDeploymentInstance and ListDeploymentInstances to get information about single and multiple deployment instances, respectively.
Deployments, which represent the process of deploying revisions to deployment groups.
You can work with deployments by calling CreateDeployment, GetDeployment, ListDeployments, BatchGetDeployments, and StopDeployment to create and get information about deployments, and to stop a deployment, respectively.
Application revisions (also known simply as revisions), which are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. Application revisions are deployed to deployment groups.
You can work with application revisions by calling GetApplicationRevision, ListApplicationRevisions, and RegisterApplicationRevision to get information about application revisions and to inform AWS CodeDeploy about an application revision, respectively.
Represents the input of a batch get applications operation.
" - }, - "output":{ - "shape":"BatchGetApplicationsOutput", - "documentation":"Represents the output of a batch get applications operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - } - ], - "documentation":"Gets information about one or more applications.
" - }, - "BatchGetDeployments":{ - "name":"BatchGetDeployments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"BatchGetDeploymentsInput", - "documentation":"Represents the input of a batch get deployments operation.
" - }, - "output":{ - "shape":"BatchGetDeploymentsOutput", - "documentation":"Represents the output of a batch get deployments operation.
" - }, - "errors":[ - { - "shape":"DeploymentIdRequiredException", - "exception":true, - "documentation":"At least one deployment ID must be specified.
" - }, - { - "shape":"InvalidDeploymentIdException", - "exception":true, - "documentation":"At least one of the deployment IDs was specified in an invalid format.
" - } - ], - "documentation":"Gets information about one or more deployments.
" - }, - "CreateApplication":{ - "name":"CreateApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateApplicationInput", - "documentation":"Represents the input of a create application operation.
" - }, - "output":{ - "shape":"CreateApplicationOutput", - "documentation":"Represents the output of a create application operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationAlreadyExistsException", - "exception":true, - "documentation":"An application with the specified name already exists within the AWS user account.
" - }, - { - "shape":"ApplicationLimitExceededException", - "exception":true, - "documentation":"More applications were attempted to be created than were allowed.
" - } - ], - "documentation":"Creates a new application.
" - }, - "CreateDeployment":{ - "name":"CreateDeployment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDeploymentInput", - "documentation":"Represents the input of a create deployment operation.
" - }, - "output":{ - "shape":"CreateDeploymentOutput", - "documentation":"Represents the output of a create deployment operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"DeploymentGroupNameRequiredException", - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - { - "shape":"InvalidDeploymentGroupNameException", - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - { - "shape":"DeploymentGroupDoesNotExistException", - "exception":true, - "documentation":"The named deployment group does not exist within the AWS user account.
" - }, - { - "shape":"RevisionRequiredException", - "exception":true, - "documentation":"The revision ID was not specified.
" - }, - { - "shape":"InvalidRevisionException", - "exception":true, - "documentation":"The revision was specified in an invalid format.
" - }, - { - "shape":"InvalidDeploymentConfigNameException", - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigDoesNotExistException", - "exception":true, - "documentation":"The deployment configuration does not exist within the AWS user account.
" - }, - { - "shape":"DescriptionTooLongException", - "exception":true, - "documentation":"The description that was provided is too long.
" - }, - { - "shape":"DeploymentLimitExceededException", - "exception":true, - "documentation":"The number of allowed deployments was exceeded.
" - } - ], - "documentation":"Deploys an application revision to the specified deployment group.
" - }, - "CreateDeploymentConfig":{ - "name":"CreateDeploymentConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDeploymentConfigInput", - "documentation":"Represents the input of a create deployment configuration operation.
" - }, - "output":{ - "shape":"CreateDeploymentConfigOutput", - "documentation":"Represents the output of a create deployment configuration operation.
" - }, - "errors":[ - { - "shape":"InvalidDeploymentConfigNameException", - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigNameRequiredException", - "exception":true, - "documentation":"The deployment configuration name was not specified.
" - }, - { - "shape":"DeploymentConfigAlreadyExistsException", - "exception":true, - "documentation":"A deployment configuration with the specified name already exists within the AWS user account.
" - }, - { - "shape":"InvalidMinimumHealthyHostValueException", - "exception":true, - "documentation":"The minimum healthy instances value was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigLimitExceededException", - "exception":true, - "documentation":"The deployment configurations limit was exceeded.
" - } - ], - "documentation":"Creates a new deployment configuration.
" - }, - "CreateDeploymentGroup":{ - "name":"CreateDeploymentGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDeploymentGroupInput", - "documentation":"Represents the input of a create deployment group operation.
" - }, - "output":{ - "shape":"CreateDeploymentGroupOutput", - "documentation":"Represents the output of a create deployment group operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"DeploymentGroupNameRequiredException", - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - { - "shape":"InvalidDeploymentGroupNameException", - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - { - "shape":"DeploymentGroupAlreadyExistsException", - "exception":true, - "documentation":"A deployment group group with the specified name already exists within the AWS user account.
" - }, - { - "shape":"InvalidEC2TagException", - "exception":true, - "documentation":"The Amazon EC2 tag was specified in an invalid format.
" - }, - { - "shape":"InvalidAutoScalingGroupException", - "exception":true, - "documentation":"The Auto Scaling group was specified in an invalid format or does not exist.
" - }, - { - "shape":"InvalidDeploymentConfigNameException", - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigDoesNotExistException", - "exception":true, - "documentation":"The deployment configuration does not exist within the AWS user account.
" - }, - { - "shape":"RoleRequiredException", - "exception":true, - "documentation":"The role ID was not specified.
" - }, - { - "shape":"InvalidRoleException", - "exception":true, - "documentation":"The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
" - }, - { - "shape":"DeploymentGroupLimitExceededException", - "exception":true, - "documentation":"The deployment groups limit was exceeded.
" - } - ], - "documentation":"Creates a new deployment group for application revisions to be deployed to.
" - }, - "DeleteApplication":{ - "name":"DeleteApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteApplicationInput", - "documentation":"Represents the input of a delete application operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - } - ], - "documentation":"Deletes an application.
" - }, - "DeleteDeploymentConfig":{ - "name":"DeleteDeploymentConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDeploymentConfigInput", - "documentation":"Represents the input of a delete deployment configuration operation.
" - }, - "errors":[ - { - "shape":"InvalidDeploymentConfigNameException", - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigNameRequiredException", - "exception":true, - "documentation":"The deployment configuration name was not specified.
" - }, - { - "shape":"DeploymentConfigInUseException", - "exception":true, - "documentation":"The deployment configuration is still in use.
" - }, - { - "shape":"InvalidOperationException", - "exception":true, - "documentation":"An invalid operation was detected.
" - } - ], - "documentation":"Deletes a deployment configuration.
Represents the input of a delete deployment group operation.
" - }, - "output":{ - "shape":"DeleteDeploymentGroupOutput", - "documentation":"Represents the output of a delete deployment group operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"DeploymentGroupNameRequiredException", - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - { - "shape":"InvalidDeploymentGroupNameException", - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - { - "shape":"InvalidRoleException", - "exception":true, - "documentation":"The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
" - } - ], - "documentation":"Deletes a deployment group.
" - }, - "GetApplication":{ - "name":"GetApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetApplicationInput", - "documentation":"Represents the input of a get application operation.
" - }, - "output":{ - "shape":"GetApplicationOutput", - "documentation":"Represents the output of a get application operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - } - ], - "documentation":"Gets information about an application.
" - }, - "GetApplicationRevision":{ - "name":"GetApplicationRevision", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetApplicationRevisionInput", - "documentation":"Represents the input of a get application revision operation.
" - }, - "output":{ - "shape":"GetApplicationRevisionOutput", - "documentation":"Represents the output of a get application revision operation.
" - }, - "errors":[ - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"RevisionDoesNotExistException", - "exception":true, - "documentation":"The named revision does not exist within the AWS user account.
" - }, - { - "shape":"RevisionRequiredException", - "exception":true, - "documentation":"The revision ID was not specified.
" - }, - { - "shape":"InvalidRevisionException", - "exception":true, - "documentation":"The revision was specified in an invalid format.
" - } - ], - "documentation":"Gets information about an application revision.
" - }, - "GetDeployment":{ - "name":"GetDeployment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetDeploymentInput", - "documentation":"Represents the input of a get deployment operation.
" - }, - "output":{ - "shape":"GetDeploymentOutput", - "documentation":"Represents the output of a get deployment operation.
" - }, - "errors":[ - { - "shape":"DeploymentIdRequiredException", - "exception":true, - "documentation":"At least one deployment ID must be specified.
" - }, - { - "shape":"InvalidDeploymentIdException", - "exception":true, - "documentation":"At least one of the deployment IDs was specified in an invalid format.
" - }, - { - "shape":"DeploymentDoesNotExistException", - "exception":true, - "documentation":"The deployment does not exist within the AWS user account.
" - } - ], - "documentation":"Gets information about a deployment.
" - }, - "GetDeploymentConfig":{ - "name":"GetDeploymentConfig", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetDeploymentConfigInput", - "documentation":"Represents the input of a get deployment configuration operation.
" - }, - "output":{ - "shape":"GetDeploymentConfigOutput", - "documentation":"Represents the output of a get deployment configuration operation.
" - }, - "errors":[ - { - "shape":"InvalidDeploymentConfigNameException", - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigNameRequiredException", - "exception":true, - "documentation":"The deployment configuration name was not specified.
" - }, - { - "shape":"DeploymentConfigDoesNotExistException", - "exception":true, - "documentation":"The deployment configuration does not exist within the AWS user account.
" - } - ], - "documentation":"Gets information about a deployment configuration.
" - }, - "GetDeploymentGroup":{ - "name":"GetDeploymentGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetDeploymentGroupInput", - "documentation":"Represents the input of a get deployment group operation.
" - }, - "output":{ - "shape":"GetDeploymentGroupOutput", - "documentation":"Represents the output of a get deployment group operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"DeploymentGroupNameRequiredException", - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - { - "shape":"InvalidDeploymentGroupNameException", - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - { - "shape":"DeploymentGroupDoesNotExistException", - "exception":true, - "documentation":"The named deployment group does not exist within the AWS user account.
" - } - ], - "documentation":"Gets information about a deployment group.
" - }, - "GetDeploymentInstance":{ - "name":"GetDeploymentInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetDeploymentInstanceInput", - "documentation":"Represents the input of a get deployment instance operation.
" - }, - "output":{ - "shape":"GetDeploymentInstanceOutput", - "documentation":"Represents the output of a get deployment instance operation.
" - }, - "errors":[ - { - "shape":"DeploymentIdRequiredException", - "exception":true, - "documentation":"At least one deployment ID must be specified.
" - }, - { - "shape":"DeploymentDoesNotExistException", - "exception":true, - "documentation":"The deployment does not exist within the AWS user account.
" - }, - { - "shape":"InstanceIdRequiredException", - "exception":true, - "documentation":"The instance ID was not specified.
" - }, - { - "shape":"InvalidDeploymentIdException", - "exception":true, - "documentation":"At least one of the deployment IDs was specified in an invalid format.
" - }, - { - "shape":"InstanceDoesNotExistException", - "exception":true, - "documentation":"The specified instance does not exist in the deployment group.
" - } - ], - "documentation":"Gets information about an Amazon EC2 instance as part of a deployment.
" - }, - "ListApplicationRevisions":{ - "name":"ListApplicationRevisions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListApplicationRevisionsInput", - "documentation":"Represents the input of a list application revisions operation.
" - }, - "output":{ - "shape":"ListApplicationRevisionsOutput", - "documentation":"Represents the output of a list application revisions operation.
" - }, - "errors":[ - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"InvalidSortByException", - "exception":true, - "documentation":"The column name to sort by is either not present or was specified in an invalid format.
" - }, - { - "shape":"InvalidSortOrderException", - "exception":true, - "documentation":"The sort order was specified in an invalid format.
" - }, - { - "shape":"InvalidBucketNameFilterException", - "exception":true, - "documentation":"The bucket name either doesn't exist or was specified in an invalid format.
" - }, - { - "shape":"InvalidKeyPrefixFilterException", - "exception":true, - "documentation":"The specified key prefix filter was specified in an invalid format.
" - }, - { - "shape":"BucketNameFilterRequiredException", - "exception":true, - "documentation":"A bucket name is required but was not provided.
" - }, - { - "shape":"InvalidDeployedStateFilterException", - "exception":true, - "documentation":"The deployed state filter was specified in an invalid format.
" - }, - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - } - ], - "documentation":"Lists information about revisions for an application.
" - }, - "ListApplications":{ - "name":"ListApplications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListApplicationsInput", - "documentation":"Represents the input of a list applications operation.
" - }, - "output":{ - "shape":"ListApplicationsOutput", - "documentation":"Represents the output of a list applications operation.
" - }, - "errors":[ - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - } - ], - "documentation":"Lists the applications registered within the AWS user account.
" - }, - "ListDeploymentConfigs":{ - "name":"ListDeploymentConfigs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListDeploymentConfigsInput", - "documentation":"Represents the input of a list deployment configurations operation.
" - }, - "output":{ - "shape":"ListDeploymentConfigsOutput", - "documentation":"Represents the output of a list deployment configurations operation.
" - }, - "errors":[ - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - } - ], - "documentation":"Lists the deployment configurations within the AWS user account.
" - }, - "ListDeploymentGroups":{ - "name":"ListDeploymentGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListDeploymentGroupsInput", - "documentation":"Represents the input of a list deployment groups operation.
" - }, - "output":{ - "shape":"ListDeploymentGroupsOutput", - "documentation":"Represents the output of a list deployment groups operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - } - ], - "documentation":"Lists the deployment groups for an application registered within the AWS user account.
" - }, - "ListDeploymentInstances":{ - "name":"ListDeploymentInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListDeploymentInstancesInput", - "documentation":"Represents the input of a list deployment instances operation.
" - }, - "output":{ - "shape":"ListDeploymentInstancesOutput", - "documentation":"Represents the output of a list deployment instances operation.
" - }, - "errors":[ - { - "shape":"DeploymentIdRequiredException", - "exception":true, - "documentation":"At least one deployment ID must be specified.
" - }, - { - "shape":"DeploymentDoesNotExistException", - "exception":true, - "documentation":"The deployment does not exist within the AWS user account.
" - }, - { - "shape":"DeploymentNotStartedException", - "exception":true, - "documentation":"The specified deployment has not started.
" - }, - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - }, - { - "shape":"InvalidDeploymentIdException", - "exception":true, - "documentation":"At least one of the deployment IDs was specified in an invalid format.
" - }, - { - "shape":"InvalidInstanceStatusException", - "exception":true, - "documentation":"The specified instance status does not exist.
" - } - ], - "documentation":"Lists the Amazon EC2 instances for a deployment within the AWS user account.
" - }, - "ListDeployments":{ - "name":"ListDeployments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListDeploymentsInput", - "documentation":"Represents the input of a list deployments operation.
" - }, - "output":{ - "shape":"ListDeploymentsOutput", - "documentation":"Represents the output of a list deployments operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"InvalidDeploymentGroupNameException", - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - { - "shape":"DeploymentGroupDoesNotExistException", - "exception":true, - "documentation":"The named deployment group does not exist within the AWS user account.
" - }, - { - "shape":"DeploymentGroupNameRequiredException", - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - { - "shape":"InvalidTimeRangeException", - "exception":true, - "documentation":"The specified time range was specified in an invalid format.
" - }, - { - "shape":"InvalidDeploymentStatusException", - "exception":true, - "documentation":"The specified deployment status doesn't exist or cannot be determined.
" - }, - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - } - ], - "documentation":"Lists the deployments under a deployment group for an application registered within the AWS user account.
" - }, - "RegisterApplicationRevision":{ - "name":"RegisterApplicationRevision", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RegisterApplicationRevisionInput", - "documentation":"Represents the input of a register application revision operation.
" - }, - "errors":[ - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"DescriptionTooLongException", - "exception":true, - "documentation":"The description that was provided is too long.
" - }, - { - "shape":"RevisionRequiredException", - "exception":true, - "documentation":"The revision ID was not specified.
" - }, - { - "shape":"InvalidRevisionException", - "exception":true, - "documentation":"The revision was specified in an invalid format.
" - } - ], - "documentation":"Registers with AWS CodeDeploy a revision for the specified application.
" - }, - "StopDeployment":{ - "name":"StopDeployment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"StopDeploymentInput", - "documentation":"Represents the input of a stop deployment operation.
" - }, - "output":{ - "shape":"StopDeploymentOutput", - "documentation":"Represents the output of a stop deployment operation.
" - }, - "errors":[ - { - "shape":"DeploymentIdRequiredException", - "exception":true, - "documentation":"At least one deployment ID must be specified.
" - }, - { - "shape":"DeploymentDoesNotExistException", - "exception":true, - "documentation":"The deployment does not exist within the AWS user account.
" - }, - { - "shape":"DeploymentAlreadyCompletedException", - "exception":true, - "documentation":"The deployment is already completed.
" - }, - { - "shape":"InvalidDeploymentIdException", - "exception":true, - "documentation":"At least one of the deployment IDs was specified in an invalid format.
" - } - ], - "documentation":"Attempts to stop an ongoing deployment.
" - }, - "UpdateApplication":{ - "name":"UpdateApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateApplicationInput", - "documentation":"Represents the input of an update application operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationAlreadyExistsException", - "exception":true, - "documentation":"An application with the specified name already exists within the AWS user account.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - } - ], - "documentation":"Changes an existing application's name.
" - }, - "UpdateDeploymentGroup":{ - "name":"UpdateDeploymentGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateDeploymentGroupInput", - "documentation":"Represents the input of an update deployment group operation.
" - }, - "output":{ - "shape":"UpdateDeploymentGroupOutput", - "documentation":"Represents the output of an update deployment group operation.
" - }, - "errors":[ - { - "shape":"ApplicationNameRequiredException", - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - { - "shape":"InvalidApplicationNameException", - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - { - "shape":"ApplicationDoesNotExistException", - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - { - "shape":"InvalidDeploymentGroupNameException", - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - { - "shape":"DeploymentGroupAlreadyExistsException", - "exception":true, - "documentation":"A deployment group group with the specified name already exists within the AWS user account.
" - }, - { - "shape":"DeploymentGroupNameRequiredException", - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - { - "shape":"InvalidEC2TagException", - "exception":true, - "documentation":"The Amazon EC2 tag was specified in an invalid format.
" - }, - { - "shape":"InvalidAutoScalingGroupException", - "exception":true, - "documentation":"The Auto Scaling group was specified in an invalid format or does not exist.
" - }, - { - "shape":"InvalidDeploymentConfigNameException", - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - { - "shape":"DeploymentConfigDoesNotExistException", - "exception":true, - "documentation":"The deployment configuration does not exist within the AWS user account.
" - }, - { - "shape":"InvalidRoleException", - "exception":true, - "documentation":"The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
" - } - ], - "documentation":"Changes information about an existing deployment group.
" - } - }, - "shapes":{ - "ApplicationAlreadyExistsException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"An application with the specified name already exists within the AWS user account.
" - }, - "ApplicationDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The application does not exist within the AWS user account.
" - }, - "ApplicationId":{"type":"string"}, - "ApplicationInfo":{ - "type":"structure", - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"The application ID.
" - }, - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The application name.
" - }, - "createTime":{ - "shape":"Timestamp", - "documentation":"The time that the application was created.
" - }, - "linkedToGitHub":{ - "shape":"Boolean", - "documentation":"True if the user has authenticated with GitHub for the specified application; otherwise, false.
" - } - }, - "documentation":"Information about an application.
" - }, - "ApplicationLimitExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"More applications were attempted to be created than were allowed.
" - }, - "ApplicationName":{ - "type":"string", - "min":1, - "max":100 - }, - "ApplicationNameRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The minimum number of required application names was not specified.
" - }, - "ApplicationRevisionSortBy":{ - "type":"string", - "enum":[ - "registerTime", - "firstUsedTime", - "lastUsedTime" - ] - }, - "ApplicationsInfoList":{ - "type":"list", - "member":{"shape":"ApplicationInfo"} - }, - "ApplicationsList":{ - "type":"list", - "member":{"shape":"ApplicationName"} - }, - "AutoScalingGroup":{ - "type":"structure", - "members":{ - "name":{ - "shape":"AutoScalingGroupName", - "documentation":"The Auto Scaling group name.
" - }, - "hook":{ - "shape":"AutoScalingGroupHook", - "documentation":"An Auto Scaling lifecycle event hook name.
" - } - }, - "documentation":"Information about an Auto Scaling group.
" - }, - "AutoScalingGroupHook":{"type":"string"}, - "AutoScalingGroupList":{ - "type":"list", - "member":{"shape":"AutoScalingGroup"} - }, - "AutoScalingGroupName":{"type":"string"}, - "AutoScalingGroupNameList":{ - "type":"list", - "member":{"shape":"AutoScalingGroupName"} - }, - "BatchGetApplicationsInput":{ - "type":"structure", - "members":{ - "applicationNames":{ - "shape":"ApplicationsList", - "documentation":"A list of application names, with multiple application names separated by spaces.
" - } - }, - "documentation":"Represents the input of a batch get applications operation.
" - }, - "BatchGetApplicationsOutput":{ - "type":"structure", - "members":{ - "applicationsInfo":{ - "shape":"ApplicationsInfoList", - "documentation":"Information about the applications.
" - } - }, - "documentation":"Represents the output of a batch get applications operation.
" - }, - "BatchGetDeploymentsInput":{ - "type":"structure", - "members":{ - "deploymentIds":{ - "shape":"DeploymentsList", - "documentation":"A list of deployment IDs, with multiple deployment IDs separated by spaces.
" - } - }, - "documentation":"Represents the input of a batch get deployments operation.
" - }, - "BatchGetDeploymentsOutput":{ - "type":"structure", - "members":{ - "deploymentsInfo":{ - "shape":"DeploymentsInfoList", - "documentation":"Information about the deployments.
" - } - }, - "documentation":"Represents the output of a batch get deployments operation.
" - }, - "Boolean":{"type":"boolean"}, - "BucketNameFilterRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"A bucket name is required but was not provided.
" - }, - "BundleType":{ - "type":"string", - "enum":[ - "tar", - "tgz", - "zip" - ] - }, - "CommitId":{"type":"string"}, - "CreateApplicationInput":{ - "type":"structure", - "required":["applicationName"], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application. This name must be unique within the AWS user account.
" - } - }, - "documentation":"Represents the input of a create application operation.
" - }, - "CreateApplicationOutput":{ - "type":"structure", - "members":{ - "applicationId":{ - "shape":"ApplicationId", - "documentation":"A unique application ID.
" - } - }, - "documentation":"Represents the output of a create application operation.
" - }, - "CreateDeploymentConfigInput":{ - "type":"structure", - "required":["deploymentConfigName"], - "members":{ - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The name of the deployment configuration to create.
" - }, - "minimumHealthyHosts":{ - "shape":"MinimumHealthyHosts", - "documentation":"The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.
The type parameter takes either of the following values:
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instances, specify a type of FLEET_PERCENT and a value of 95.
" - } - }, - "documentation":"Represents the input of a create deployment configuration operation.
" - }, - "CreateDeploymentConfigOutput":{ - "type":"structure", - "members":{ - "deploymentConfigId":{ - "shape":"DeploymentConfigId", - "documentation":"A unique deployment configuration ID.
" - } - }, - "documentation":"Represents the output of a create deployment configuration operation.
" - }, - "CreateDeploymentGroupInput":{ - "type":"structure", - "required":[ - "applicationName", - "deploymentGroupName" - ], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The name of an existing deployment group for the specified application.
" - }, - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:
To create a custom deployment configuration, call the create deployment configuration operation.
" - }, - "ec2TagFilters":{ - "shape":"EC2TagFilterList", - "documentation":"The Amazon EC2 tags to filter on.
" - }, - "autoScalingGroups":{ - "shape":"AutoScalingGroupNameList", - "documentation":"A list of associated Auto Scaling groups.
" - }, - "serviceRoleArn":{ - "shape":"Role", - "documentation":"A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
" - } - }, - "documentation":"Represents the input of a create deployment group operation.
" - }, - "CreateDeploymentGroupOutput":{ - "type":"structure", - "members":{ - "deploymentGroupId":{ - "shape":"DeploymentGroupId", - "documentation":"A unique deployment group ID.
" - } - }, - "documentation":"Represents the output of a create deployment group operation.
" - }, - "CreateDeploymentInput":{ - "type":"structure", - "required":["applicationName"], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The deployment group's name.
" - }, - "revision":{ - "shape":"RevisionLocation", - "documentation":"The type of revision to deploy, along with information about the revision's location.
" - }, - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The name of an existing deployment configuration within the AWS user account.
If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.
" - }, - "description":{ - "shape":"Description", - "documentation":"A comment about the deployment.
" - }, - "ignoreApplicationStopFailures":{ - "shape":"Boolean", - "documentation":"If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
" - } - }, - "documentation":"Represents the input of a create deployment operation.
" - }, - "CreateDeploymentOutput":{ - "type":"structure", - "members":{ - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"A unique deployment ID.
" - } - }, - "documentation":"Represents the output of a create deployment operation.
" - }, - "DeleteApplicationInput":{ - "type":"structure", - "required":["applicationName"], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - } - }, - "documentation":"Represents the input of a delete application operation.
" - }, - "DeleteDeploymentConfigInput":{ - "type":"structure", - "required":["deploymentConfigName"], - "members":{ - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The name of an existing deployment configuration within the AWS user account.
" - } - }, - "documentation":"Represents the input of a delete deployment configuration operation.
" - }, - "DeleteDeploymentGroupInput":{ - "type":"structure", - "required":[ - "applicationName", - "deploymentGroupName" - ], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The name of an existing deployment group for the specified application.
" - } - }, - "documentation":"Represents the input of a delete deployment group operation.
" - }, - "DeleteDeploymentGroupOutput":{ - "type":"structure", - "members":{ - "hooksNotCleanedUp":{ - "shape":"AutoScalingGroupList", - "documentation":"If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the instances in the Auto Scaling. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the instances in the Auto Scaling group.
" - } - }, - "documentation":"Represents the output of a delete deployment group operation.
" - }, - "DeploymentAlreadyCompletedException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment is already completed.
" - }, - "DeploymentConfigAlreadyExistsException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"A deployment configuration with the specified name already exists within the AWS user account.
" - }, - "DeploymentConfigDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment configuration does not exist within the AWS user account.
" - }, - "DeploymentConfigId":{"type":"string"}, - "DeploymentConfigInUseException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment configuration is still in use.
" - }, - "DeploymentConfigInfo":{ - "type":"structure", - "members":{ - "deploymentConfigId":{ - "shape":"DeploymentConfigId", - "documentation":"The deployment configuration ID.
" - }, - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The deployment configuration name.
" - }, - "minimumHealthyHosts":{ - "shape":"MinimumHealthyHosts", - "documentation":"Information about the number or percentage of minimum healthy instances.
" - }, - "createTime":{ - "shape":"Timestamp", - "documentation":"The time that the deployment configuration was created.
" - } - }, - "documentation":"Information about a deployment configuration.
" - }, - "DeploymentConfigLimitExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment configurations limit was exceeded.
" - }, - "DeploymentConfigName":{ - "type":"string", - "min":1, - "max":100 - }, - "DeploymentConfigNameRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment configuration name was not specified.
" - }, - "DeploymentConfigsList":{ - "type":"list", - "member":{"shape":"DeploymentConfigName"} - }, - "DeploymentCreator":{ - "type":"string", - "enum":[ - "user", - "autoscaling" - ] - }, - "DeploymentDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment does not exist within the AWS user account.
" - }, - "DeploymentGroupAlreadyExistsException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"A deployment group group with the specified name already exists within the AWS user account.
" - }, - "DeploymentGroupDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The named deployment group does not exist within the AWS user account.
" - }, - "DeploymentGroupId":{"type":"string"}, - "DeploymentGroupInfo":{ - "type":"structure", - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The application name.
" - }, - "deploymentGroupId":{ - "shape":"DeploymentGroupId", - "documentation":"The deployment group ID.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The deployment group name.
" - }, - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The deployment configuration name.
" - }, - "ec2TagFilters":{ - "shape":"EC2TagFilterList", - "documentation":"The Amazon EC2 tags to filter on.
" - }, - "autoScalingGroups":{ - "shape":"AutoScalingGroupList", - "documentation":"A list of associated Auto Scaling groups.
" - }, - "serviceRoleArn":{ - "shape":"Role", - "documentation":"A service role ARN.
" - }, - "targetRevision":{ - "shape":"RevisionLocation", - "documentation":"Information about the deployment group's target revision, including the revision's type and its location.
" - } - }, - "documentation":"Information about a deployment group.
" - }, - "DeploymentGroupLimitExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment groups limit was exceeded.
" - }, - "DeploymentGroupName":{ - "type":"string", - "min":1, - "max":100 - }, - "DeploymentGroupNameRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment group name was not specified.
" - }, - "DeploymentGroupsList":{ - "type":"list", - "member":{"shape":"DeploymentGroupName"} - }, - "DeploymentId":{"type":"string"}, - "DeploymentIdRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"At least one deployment ID must be specified.
" - }, - "DeploymentInfo":{ - "type":"structure", - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The application name.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The deployment group name.
" - }, - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The deployment configuration name.
" - }, - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"The deployment ID.
" - }, - "revision":{ - "shape":"RevisionLocation", - "documentation":"Information about the location of application artifacts that are stored and the service to retrieve them from.
" - }, - "status":{ - "shape":"DeploymentStatus", - "documentation":"The current state of the deployment as a whole.
" - }, - "errorInformation":{ - "shape":"ErrorInformation", - "documentation":"Information about any error associated with this deployment.
" - }, - "createTime":{ - "shape":"Timestamp", - "documentation":"A timestamp indicating when the deployment was created.
" - }, - "startTime":{ - "shape":"Timestamp", - "documentation":"A timestamp indicating when the deployment began deploying to the deployment group.
Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process.
" - }, - "completeTime":{ - "shape":"Timestamp", - "documentation":"A timestamp indicating when the deployment was completed.
" - }, - "deploymentOverview":{ - "shape":"DeploymentOverview", - "documentation":"A summary of the deployment status of the instances in the deployment.
" - }, - "description":{ - "shape":"Description", - "documentation":"A comment about the deployment.
" - }, - "creator":{ - "shape":"DeploymentCreator", - "documentation":"How the deployment was created:
If true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.
If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
" - } - }, - "documentation":"Information about a deployment.
" - }, - "DeploymentLimitExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The number of allowed deployments was exceeded.
" - }, - "DeploymentNotStartedException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified deployment has not started.
" - }, - "DeploymentOverview":{ - "type":"structure", - "members":{ - "Pending":{ - "shape":"InstanceCount", - "documentation":"The number of instances that are pending in the deployment.
" - }, - "InProgress":{ - "shape":"InstanceCount", - "documentation":"The number of instances that are in progress in the deployment.
" - }, - "Succeeded":{ - "shape":"InstanceCount", - "documentation":"The number of instances that have succeeded in the deployment.
" - }, - "Failed":{ - "shape":"InstanceCount", - "documentation":"The number of instances that have failed in the deployment.
" - }, - "Skipped":{ - "shape":"InstanceCount", - "documentation":"The number of instances that have been skipped in the deployment.
" - } - }, - "documentation":"Information about the deployment status of the instances in the deployment.
" - }, - "DeploymentStatus":{ - "type":"string", - "enum":[ - "Created", - "Queued", - "InProgress", - "Succeeded", - "Failed", - "Stopped" - ] - }, - "DeploymentStatusList":{ - "type":"list", - "member":{"shape":"DeploymentStatus"} - }, - "DeploymentsInfoList":{ - "type":"list", - "member":{"shape":"DeploymentInfo"} - }, - "DeploymentsList":{ - "type":"list", - "member":{"shape":"DeploymentId"} - }, - "Description":{"type":"string"}, - "DescriptionTooLongException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The description that was provided is too long.
" - }, - "Diagnostics":{ - "type":"structure", - "members":{ - "errorCode":{ - "shape":"LifecycleErrorCode", - "documentation":"The associated error code:
The name of the script.
" - }, - "message":{ - "shape":"LifecycleMessage", - "documentation":"The message associated with the error.
" - }, - "logTail":{ - "shape":"LogTail", - "documentation":"The last portion of the associated diagnostic log.
" - } - }, - "documentation":"Diagnostic information about executable scripts that are part of a deployment.
" - }, - "EC2TagFilter":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"Key", - "documentation":"The Amazon EC2 tag filter key.
" - }, - "Value":{ - "shape":"Value", - "documentation":"The Amazon EC2 tag filter value.
" - }, - "Type":{ - "shape":"EC2TagFilterType", - "documentation":"The Amazon EC2 tag filter type:
Information about an Amazon EC2 tag filter.
" - }, - "EC2TagFilterList":{ - "type":"list", - "member":{"shape":"EC2TagFilter"} - }, - "EC2TagFilterType":{ - "type":"string", - "enum":[ - "KEY_ONLY", - "VALUE_ONLY", - "KEY_AND_VALUE" - ] - }, - "ETag":{"type":"string"}, - "ErrorCode":{ - "type":"string", - "enum":[ - "DEPLOYMENT_GROUP_MISSING", - "APPLICATION_MISSING", - "REVISION_MISSING", - "IAM_ROLE_MISSING", - "IAM_ROLE_PERMISSIONS", - "OVER_MAX_INSTANCES", - "NO_INSTANCES", - "TIMEOUT", - "HEALTH_CONSTRAINTS_INVALID", - "HEALTH_CONSTRAINTS", - "INTERNAL_ERROR" - ] - }, - "ErrorInformation":{ - "type":"structure", - "members":{ - "code":{ - "shape":"ErrorCode", - "documentation":"The error code:
An accompanying error message.
" - } - }, - "documentation":"Information about a deployment error.
" - }, - "ErrorMessage":{"type":"string"}, - "GenericRevisionInfo":{ - "type":"structure", - "members":{ - "description":{ - "shape":"Description", - "documentation":"A comment about the revision.
" - }, - "deploymentGroups":{ - "shape":"DeploymentGroupsList", - "documentation":"A list of deployment groups that use this revision.
" - }, - "firstUsedTime":{ - "shape":"Timestamp", - "documentation":"When the revision was first used by AWS CodeDeploy.
" - }, - "lastUsedTime":{ - "shape":"Timestamp", - "documentation":"When the revision was last used by AWS CodeDeploy.
" - }, - "registerTime":{ - "shape":"Timestamp", - "documentation":"When the revision was registered with AWS CodeDeploy.
" - } - }, - "documentation":"Information about an application revision.
" - }, - "GetApplicationInput":{ - "type":"structure", - "required":["applicationName"], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - } - }, - "documentation":"Represents the input of a get application operation.
" - }, - "GetApplicationOutput":{ - "type":"structure", - "members":{ - "application":{ - "shape":"ApplicationInfo", - "documentation":"Information about the application.
" - } - }, - "documentation":"Represents the output of a get application operation.
" - }, - "GetApplicationRevisionInput":{ - "type":"structure", - "required":[ - "applicationName", - "revision" - ], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application that corresponds to the revision.
" - }, - "revision":{ - "shape":"RevisionLocation", - "documentation":"Information about the application revision to get, including the revision's type and its location.
" - } - }, - "documentation":"Represents the input of a get application revision operation.
" - }, - "GetApplicationRevisionOutput":{ - "type":"structure", - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application that corresponds to the revision.
" - }, - "revision":{ - "shape":"RevisionLocation", - "documentation":"Additional information about the revision, including the revision's type and its location.
" - }, - "revisionInfo":{ - "shape":"GenericRevisionInfo", - "documentation":"General information about the revision.
" - } - }, - "documentation":"Represents the output of a get application revision operation.
" - }, - "GetDeploymentConfigInput":{ - "type":"structure", - "required":["deploymentConfigName"], - "members":{ - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The name of an existing deployment configuration within the AWS user account.
" - } - }, - "documentation":"Represents the input of a get deployment configuration operation.
" - }, - "GetDeploymentConfigOutput":{ - "type":"structure", - "members":{ - "deploymentConfigInfo":{ - "shape":"DeploymentConfigInfo", - "documentation":"Information about the deployment configuration.
" - } - }, - "documentation":"Represents the output of a get deployment configuration operation.
" - }, - "GetDeploymentGroupInput":{ - "type":"structure", - "required":[ - "applicationName", - "deploymentGroupName" - ], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The name of an existing deployment group for the specified application.
" - } - }, - "documentation":"Represents the input of a get deployment group operation.
" - }, - "GetDeploymentGroupOutput":{ - "type":"structure", - "members":{ - "deploymentGroupInfo":{ - "shape":"DeploymentGroupInfo", - "documentation":"Information about the deployment group.
" - } - }, - "documentation":"Represents the output of a get deployment group operation.
" - }, - "GetDeploymentInput":{ - "type":"structure", - "required":["deploymentId"], - "members":{ - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"An existing deployment ID within the AWS user account.
" - } - }, - "documentation":"Represents the input of a get deployment operation.
" - }, - "GetDeploymentInstanceInput":{ - "type":"structure", - "required":[ - "deploymentId", - "instanceId" - ], - "members":{ - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"The unique ID of a deployment.
" - }, - "instanceId":{ - "shape":"InstanceId", - "documentation":"The unique ID of an Amazon EC2 instance in the deployment's deployment group.
" - } - }, - "documentation":"Represents the input of a get deployment instance operation.
" - }, - "GetDeploymentInstanceOutput":{ - "type":"structure", - "members":{ - "instanceSummary":{ - "shape":"InstanceSummary", - "documentation":"Information about the instance.
" - } - }, - "documentation":"Represents the output of a get deployment instance operation.
" - }, - "GetDeploymentOutput":{ - "type":"structure", - "members":{ - "deploymentInfo":{ - "shape":"DeploymentInfo", - "documentation":"Information about the deployment.
" - } - }, - "documentation":"Represents the output of a get deployment operation.
" - }, - "GitHubLocation":{ - "type":"structure", - "members":{ - "repository":{ - "shape":"Repository", - "documentation":"The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.
Specified as account/repository.
" - }, - "commitId":{ - "shape":"CommitId", - "documentation":"The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.
" - } - }, - "documentation":"Information about the location of application artifacts that are stored in GitHub.
" - }, - "InstanceCount":{"type":"long"}, - "InstanceDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified instance does not exist in the deployment group.
" - }, - "InstanceId":{"type":"string"}, - "InstanceIdRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The instance ID was not specified.
" - }, - "InstanceStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Succeeded", - "Failed", - "Skipped", - "Unknown" - ] - }, - "InstanceStatusList":{ - "type":"list", - "member":{"shape":"InstanceStatus"} - }, - "InstanceSummary":{ - "type":"structure", - "members":{ - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"The deployment ID.
" - }, - "instanceId":{ - "shape":"InstanceId", - "documentation":"The instance ID.
" - }, - "status":{ - "shape":"InstanceStatus", - "documentation":"The deployment status for this instance:
A timestamp indicating when the instance information was last updated.
" - }, - "lifecycleEvents":{ - "shape":"LifecycleEventList", - "documentation":"A list of lifecycle events for this instance.
" - } - }, - "documentation":"Information about an Amazon EC2 instance in a deployment.
" - }, - "InstancesList":{ - "type":"list", - "member":{"shape":"InstanceId"} - }, - "InvalidApplicationNameException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The application name was specified in an invalid format.
" - }, - "InvalidAutoScalingGroupException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The Auto Scaling group was specified in an invalid format or does not exist.
" - }, - "InvalidBucketNameFilterException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The bucket name either doesn't exist or was specified in an invalid format.
" - }, - "InvalidDeployedStateFilterException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployed state filter was specified in an invalid format.
" - }, - "InvalidDeploymentConfigNameException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment configuration name was specified in an invalid format.
" - }, - "InvalidDeploymentGroupNameException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The deployment group name was specified in an invalid format.
" - }, - "InvalidDeploymentIdException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"At least one of the deployment IDs was specified in an invalid format.
" - }, - "InvalidDeploymentStatusException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified deployment status doesn't exist or cannot be determined.
" - }, - "InvalidEC2TagException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The Amazon EC2 tag was specified in an invalid format.
" - }, - "InvalidInstanceStatusException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified instance status does not exist.
" - }, - "InvalidKeyPrefixFilterException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified key prefix filter was specified in an invalid format.
" - }, - "InvalidMinimumHealthyHostValueException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The minimum healthy instances value was specified in an invalid format.
" - }, - "InvalidNextTokenException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The next token was specified in an invalid format.
" - }, - "InvalidOperationException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"An invalid operation was detected.
" - }, - "InvalidRevisionException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The revision was specified in an invalid format.
" - }, - "InvalidRoleException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.
" - }, - "InvalidSortByException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The column name to sort by is either not present or was specified in an invalid format.
" - }, - "InvalidSortOrderException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The sort order was specified in an invalid format.
" - }, - "InvalidTimeRangeException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified time range was specified in an invalid format.
" - }, - "Key":{"type":"string"}, - "LifecycleErrorCode":{ - "type":"string", - "enum":[ - "Success", - "ScriptMissing", - "ScriptNotExecutable", - "ScriptTimedOut", - "ScriptFailed", - "UnknownError" - ] - }, - "LifecycleEvent":{ - "type":"structure", - "members":{ - "lifecycleEventName":{ - "shape":"LifecycleEventName", - "documentation":"The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
" - }, - "diagnostics":{ - "shape":"Diagnostics", - "documentation":"Diagnostic information about the deployment lifecycle event.
" - }, - "startTime":{ - "shape":"Timestamp", - "documentation":"A timestamp indicating when the deployment lifecycle event started.
" - }, - "endTime":{ - "shape":"Timestamp", - "documentation":"A timestamp indicating when the deployment lifecycle event ended.
" - }, - "status":{ - "shape":"LifecycleEventStatus", - "documentation":"The deployment lifecycle event status:
Information about a deployment lifecycle event.
" - }, - "LifecycleEventList":{ - "type":"list", - "member":{"shape":"LifecycleEvent"} - }, - "LifecycleEventName":{"type":"string"}, - "LifecycleEventStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Succeeded", - "Failed", - "Skipped", - "Unknown" - ] - }, - "LifecycleMessage":{"type":"string"}, - "ListApplicationRevisionsInput":{ - "type":"structure", - "required":["applicationName"], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "sortBy":{ - "shape":"ApplicationRevisionSortBy", - "documentation":"The column name to sort the list results by:
If not specified or set to null, the results will be returned in an arbitrary order.
" - }, - "sortOrder":{ - "shape":"SortOrder", - "documentation":"The order to sort the list results by:
If not specified, the results will be sorted in ascending order.
If set to null, the results will be sorted in an arbitrary order.
" - }, - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"A specific Amazon S3 bucket name to limit the search for revisions.
If set to null, then all of the user's buckets will be searched.
" - }, - "s3KeyPrefix":{ - "shape":"S3Key", - "documentation":"A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.
" - }, - "deployed":{ - "shape":"ListStateFilterAction", - "documentation":"Whether to list revisions based on whether the revision is the target revision of an deployment group:
An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.
" - } - }, - "documentation":"Represents the input of a list application revisions operation.
" - }, - "ListApplicationRevisionsOutput":{ - "type":"structure", - "members":{ - "revisions":{ - "shape":"RevisionLocationList", - "documentation":"A list of revision locations that contain the matching revisions.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
" - } - }, - "documentation":"Represents the output of a list application revisions operation.
" - }, - "ListApplicationsInput":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"An identifier that was returned from the previous list applications call, which can be used to return the next set of applications in the list.
" - } - }, - "documentation":"Represents the input of a list applications operation.
" - }, - "ListApplicationsOutput":{ - "type":"structure", - "members":{ - "applications":{ - "shape":"ApplicationsList", - "documentation":"A list of application names.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list applications call to return the next set of applications in the list.
" - } - }, - "documentation":"Represents the output of a list applications operation.
" - }, - "ListDeploymentConfigsInput":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"An identifier that was returned from the previous list deployment configurations call, which can be used to return the next set of deployment configurations in the list.
" - } - }, - "documentation":"Represents the input of a list deployment configurations operation.
" - }, - "ListDeploymentConfigsOutput":{ - "type":"structure", - "members":{ - "deploymentConfigsList":{ - "shape":"DeploymentConfigsList", - "documentation":"A list of deployment configurations, including the built-in configurations such as CodeDeployDefault.OneAtATime.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
" - } - }, - "documentation":"Represents the output of a list deployment configurations operation.
" - }, - "ListDeploymentGroupsInput":{ - "type":"structure", - "required":["applicationName"], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"An identifier that was returned from the previous list deployment groups call, which can be used to return the next set of deployment groups in the list.
" - } - }, - "documentation":"Represents the input of a list deployment groups operation.
" - }, - "ListDeploymentGroupsOutput":{ - "type":"structure", - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The application name.
" - }, - "deploymentGroups":{ - "shape":"DeploymentGroupsList", - "documentation":"A list of corresponding deployment group names.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
" - } - }, - "documentation":"Represents the output of a list deployment groups operation.
" - }, - "ListDeploymentInstancesInput":{ - "type":"structure", - "required":["deploymentId"], - "members":{ - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"The unique ID of a deployment.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"An identifier that was returned from the previous list deployment instances call, which can be used to return the next set of deployment instances in the list.
" - }, - "instanceStatusFilter":{ - "shape":"InstanceStatusList", - "documentation":"A subset of instances to list, by status:
Represents the input of a list deployment instances operation.
" - }, - "ListDeploymentInstancesOutput":{ - "type":"structure", - "members":{ - "instancesList":{ - "shape":"InstancesList", - "documentation":"A list of instance IDs.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
" - } - }, - "documentation":"Represents the output of a list deployment instances operation.
" - }, - "ListDeploymentsInput":{ - "type":"structure", - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "deploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The name of an existing deployment group for the specified application.
" - }, - "includeOnlyStatuses":{ - "shape":"DeploymentStatusList", - "documentation":"A deployment creation start- and end-time range for returning a subset of the list of deployments.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.
" - } - }, - "documentation":"Represents the input of a list deployments operation.
" - }, - "ListDeploymentsOutput":{ - "type":"structure", - "members":{ - "deployments":{ - "shape":"DeploymentsList", - "documentation":"A list of deployment IDs.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployments call to return the next set of deployments in the list.
" - } - }, - "documentation":"Represents the output of a list deployments operation.
" - }, - "ListStateFilterAction":{ - "type":"string", - "enum":[ - "include", - "exclude", - "ignore" - ] - }, - "LogTail":{"type":"string"}, - "Message":{"type":"string"}, - "MinimumHealthyHosts":{ - "type":"structure", - "members":{ - "value":{ - "shape":"MinimumHealthyHostsValue", - "documentation":"The minimum healthy instances value.
" - }, - "type":{ - "shape":"MinimumHealthyHostsType", - "documentation":"The minimum healthy instances type:
For example, for 9 Amazon EC2 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails.
Information about minimum healthy instances.
" - }, - "MinimumHealthyHostsType":{ - "type":"string", - "enum":[ - "HOST_COUNT", - "FLEET_PERCENT" - ] - }, - "MinimumHealthyHostsValue":{"type":"integer"}, - "NextToken":{"type":"string"}, - "RegisterApplicationRevisionInput":{ - "type":"structure", - "required":[ - "applicationName", - "revision" - ], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The name of an existing AWS CodeDeploy application within the AWS user account.
" - }, - "description":{ - "shape":"Description", - "documentation":"A comment about the revision.
" - }, - "revision":{ - "shape":"RevisionLocation", - "documentation":"Information about the application revision to register, including the revision's type and its location.
" - } - }, - "documentation":"Represents the input of a register application revision operation.
" - }, - "Repository":{"type":"string"}, - "RevisionDoesNotExistException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The named revision does not exist within the AWS user account.
" - }, - "RevisionLocation":{ - "type":"structure", - "members":{ - "revisionType":{ - "shape":"RevisionLocationType", - "documentation":"The application revision's type:
Information about an application revision's location.
" - }, - "RevisionLocationList":{ - "type":"list", - "member":{"shape":"RevisionLocation"} - }, - "RevisionLocationType":{ - "type":"string", - "enum":[ - "S3", - "GitHub" - ] - }, - "RevisionRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The revision ID was not specified.
" - }, - "Role":{"type":"string"}, - "RoleRequiredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The role ID was not specified.
" - }, - "S3Bucket":{"type":"string"}, - "S3Key":{"type":"string"}, - "S3Location":{ - "type":"structure", - "members":{ - "bucket":{ - "shape":"S3Bucket", - "documentation":"The name of the Amazon S3 bucket where the application revision is stored.
" - }, - "key":{ - "shape":"S3Key", - "documentation":"The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
" - }, - "bundleType":{ - "shape":"BundleType", - "documentation":"The file type of the application revision. Must be one of the following:
A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the version is not specified, the system will use the most recent version by default.
" - }, - "eTag":{ - "shape":"ETag", - "documentation":"The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.
If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.
" - } - }, - "documentation":"Information about the location of application artifacts that are stored in Amazon S3.
" - }, - "ScriptName":{"type":"string"}, - "SortOrder":{ - "type":"string", - "enum":[ - "ascending", - "descending" - ] - }, - "StopDeploymentInput":{ - "type":"structure", - "required":["deploymentId"], - "members":{ - "deploymentId":{ - "shape":"DeploymentId", - "documentation":"The unique ID of a deployment.
" - } - }, - "documentation":"Represents the input of a stop deployment operation.
" - }, - "StopDeploymentOutput":{ - "type":"structure", - "members":{ - "status":{ - "shape":"StopStatus", - "documentation":"The status of the stop deployment operation:
An accompanying status message.
" - } - }, - "documentation":"Represents the output of a stop deployment operation.
" - }, - "StopStatus":{ - "type":"string", - "enum":[ - "Pending", - "Succeeded" - ] - }, - "TimeRange":{ - "type":"structure", - "members":{ - "start":{ - "shape":"Timestamp", - "documentation":"The time range's start time.
The time range's end time.
Information about a time range.
" - }, - "Timestamp":{"type":"timestamp"}, - "UpdateApplicationInput":{ - "type":"structure", - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The current name of the application that you want to change.
" - }, - "newApplicationName":{ - "shape":"ApplicationName", - "documentation":"The new name that you want to change the application to.
" - } - }, - "documentation":"Represents the input of an update application operation.
" - }, - "UpdateDeploymentGroupInput":{ - "type":"structure", - "required":[ - "applicationName", - "currentDeploymentGroupName" - ], - "members":{ - "applicationName":{ - "shape":"ApplicationName", - "documentation":"The application name corresponding to the deployment group to update.
" - }, - "currentDeploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The current name of the existing deployment group.
" - }, - "newDeploymentGroupName":{ - "shape":"DeploymentGroupName", - "documentation":"The new name of the deployment group, if you want to change it.
" - }, - "deploymentConfigName":{ - "shape":"DeploymentConfigName", - "documentation":"The replacement deployment configuration name to use, if you want to change it.
" - }, - "ec2TagFilters":{ - "shape":"EC2TagFilterList", - "documentation":"The replacement set of Amazon EC2 tags to filter on, if you want to change them.
" - }, - "autoScalingGroups":{ - "shape":"AutoScalingGroupNameList", - "documentation":"The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
" - }, - "serviceRoleArn":{ - "shape":"Role", - "documentation":"A replacement service role's ARN, if you want to change it.
" - } - }, - "documentation":"Represents the input of an update deployment group operation.
" - }, - "UpdateDeploymentGroupOutput":{ - "type":"structure", - "members":{ - "hooksNotCleanedUp":{ - "shape":"AutoScalingGroupList", - "documentation":"If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS user account. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS user account.
" - } - }, - "documentation":"Represents the output of an update deployment group operation.
" - }, - "Value":{"type":"string"}, - "VersionId":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/cognito-identity/2014-06-30.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/cognito-identity/2014-06-30.normal.json deleted file mode 100644 index e05487d770..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/cognito-identity/2014-06-30.normal.json +++ /dev/null @@ -1,1659 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-06-30", - "endpointPrefix":"cognito-identity", - "jsonVersion":"1.1", - "serviceFullName":"Amazon Cognito Identity", - "signatureVersion":"v4", - "targetPrefix":"AWSCognitoIdentityService", - "protocol":"json" - }, - "documentation":"Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.
Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.
", - "operations":{ - "CreateIdentityPool":{ - "name":"CreateIdentityPool", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateIdentityPoolInput", - "documentation":"Input to the CreateIdentityPool action.
" - }, - "output":{ - "shape":"IdentityPool", - "documentation":"An object representing a Cognito identity pool." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"ResourceConflictException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"Thrown when a user tries to use a login which is already linked to another account." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown when the total number of user pools has exceeded a preset limit." - } - ], - "documentation":"Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account.
" - }, - "DeleteIdentityPool":{ - "name":"DeleteIdentityPool", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteIdentityPoolInput", - "documentation":"Input to the DeleteIdentityPool action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ], - "documentation":"Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
" - }, - "DescribeIdentity":{ - "name":"DescribeIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeIdentityInput", - "documentation":"Input to the DescribeIdentity action.
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
" - }, - "DescribeIdentityPool":{ - "name":"DescribeIdentityPool", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeIdentityPoolInput", - "documentation":"Input to the DescribeIdentityPool action." - }, - "output":{ - "shape":"IdentityPool", - "documentation":"An object representing a Cognito identity pool." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ], - "documentation":"Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
" - }, - "GetCredentialsForIdentity":{ - "name":"GetCredentialsForIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetCredentialsForIdentityInput", - "documentation":"Input to the GetCredentialsForIdentity action.
Returned in response to a successful GetCredentialsForIdentity operation.
Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
" - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ], - "documentation":"Returns credentials for the the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
" - }, - "GetId":{ - "name":"GetId", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetIdInput", - "documentation":"Input to the GetId action." - }, - "output":{ - "shape":"GetIdResponse", - "documentation":"Returned in response to a GetId request." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"ResourceConflictException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"Thrown when a user tries to use a login which is already linked to another account." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown when the total number of user pools has exceeded a preset limit." - } - ], - "documentation":"Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
" - }, - "GetIdentityPoolRoles":{ - "name":"GetIdentityPoolRoles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetIdentityPoolRolesInput", - "documentation":"Input to the GetIdentityPoolRoles action.
Returned in response to a successful GetIdentityPoolRoles operation.
Gets the roles for an identity pool.
" - }, - "GetOpenIdToken":{ - "name":"GetOpenIdToken", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetOpenIdTokenInput", - "documentation":"Input to the GetOpenIdToken action." - }, - "output":{ - "shape":"GetOpenIdTokenResponse", - "documentation":"Returned in response to a successful GetOpenIdToken request." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"ResourceConflictException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"Thrown when a user tries to use a login which is already linked to another account." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ], - "documentation":"Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 15 minutes.
" - }, - "GetOpenIdTokenForDeveloperIdentity":{ - "name":"GetOpenIdTokenForDeveloperIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetOpenIdTokenForDeveloperIdentityInput", - "documentation":"Input to the GetOpenIdTokenForDeveloperIdentity action.
Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.
The provided developer user identifier is already registered with Cognito under a different identity ID.
" - } - ], - "documentation":"Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the \"domain\" by which Cognito will refer to your users.
You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.
Lists the identities in a pool.
" - }, - "ListIdentityPools":{ - "name":"ListIdentityPools", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListIdentityPoolsInput", - "documentation":"Input to the ListIdentityPools action." - }, - "output":{ - "shape":"ListIdentityPoolsResponse", - "documentation":"The result of a successful ListIdentityPools action." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ], - "documentation":"Lists all of the Cognito identity pools registered for your account.
" - }, - "LookupDeveloperIdentity":{ - "name":"LookupDeveloperIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"LookupDeveloperIdentityInput", - "documentation":"Input to the LookupDeveloperIdentityInput action.
Returned in response to a successful LookupDeveloperIdentity action.
Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.
Input to the MergeDeveloperIdentities action.
Returned in response to a successful MergeDeveloperIdentities action.
Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.
Input to the SetIdentityPoolRoles action.
Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
Input to the UnlinkDeveloperIdentity action.
Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.
Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
" - }, - "UpdateIdentityPool":{ - "name":"UpdateIdentityPool", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"IdentityPool", - "documentation":"An object representing a Cognito identity pool." - }, - "output":{ - "shape":"IdentityPool", - "documentation":"An object representing a Cognito identity pool." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Thrown when the requested resource (for example, a dataset or record) does not exist." - }, - { - "shape":"NotAuthorizedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"ResourceConflictException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"Thrown when a user tries to use a login which is already linked to another account." - }, - { - "shape":"TooManyRequestsException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Thrown when a request is throttled." - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ], - "documentation":"Updates a user pool.
" - } - }, - "shapes":{ - "ARNString":{ - "type":"string", - "min":20, - "max":2048 - }, - "AccessKeyString":{"type":"string"}, - "AccountId":{ - "type":"string", - "min":1, - "max":15, - "pattern":"\\d+" - }, - "CreateIdentityPoolInput":{ - "type":"structure", - "required":[ - "IdentityPoolName", - "AllowUnauthenticatedIdentities" - ], - "members":{ - "IdentityPoolName":{ - "shape":"IdentityPoolName", - "documentation":"A string that you provide.
" - }, - "AllowUnauthenticatedIdentities":{ - "shape":"IdentityPoolUnauthenticated", - "documentation":"TRUE if the identity pool supports unauthenticated logins.
" - }, - "SupportedLoginProviders":{ - "shape":"IdentityProviders", - "documentation":"Optional key:value pairs mapping provider names to provider app IDs.
" - }, - "DeveloperProviderName":{ - "shape":"DeveloperProviderName", - "documentation":"The \"domain\" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
" - }, - "OpenIdConnectProviderARNs":{ - "shape":"OIDCProviderList", - "documentation":"A list of OpendID Connect provider ARNs.
" - } - }, - "documentation":"Input to the CreateIdentityPool action.
" - }, - "Credentials":{ - "type":"structure", - "members":{ - "AccessKeyId":{ - "shape":"AccessKeyString", - "documentation":"The Access Key portion of the credentials.
" - }, - "SecretKey":{ - "shape":"SecretKeyString", - "documentation":"The Secret Access Key portion of the credentials
" - }, - "SessionToken":{ - "shape":"SessionTokenString", - "documentation":"The Session Token portion of the credentials
" - }, - "Expiration":{ - "shape":"DateType", - "documentation":"The date at which these credentials will expire.
" - } - }, - "documentation":"Credentials for the the provided identity ID.
" - }, - "DateType":{"type":"timestamp"}, - "DeleteIdentityPoolInput":{ - "type":"structure", - "required":["IdentityPoolId"], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - } - }, - "documentation":"Input to the DeleteIdentityPool action.
" - }, - "DescribeIdentityInput":{ - "type":"structure", - "required":["IdentityId"], - "members":{ - "IdentityId":{ - "shape":"IdentityId", - "documentation":"A unique identifier in the format REGION:GUID.
" - } - }, - "documentation":"Input to the DescribeIdentity action.
This developer user identifier is already registered with Cognito.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The provided developer user identifier is already registered with Cognito under a different identity ID.
" - }, - "DeveloperUserIdentifier":{ - "type":"string", - "min":1, - "max":1024, - "pattern":"[\\w.@_-]+" - }, - "DeveloperUserIdentifierList":{ - "type":"list", - "member":{"shape":"DeveloperUserIdentifier"} - }, - "GetCredentialsForIdentityInput":{ - "type":"structure", - "required":["IdentityId"], - "members":{ - "IdentityId":{ - "shape":"IdentityId", - "documentation":"A unique identifier in the format REGION:GUID.
" - }, - "Logins":{ - "shape":"LoginsMap", - "documentation":"A set of optional name-value pairs that map provider names to provider tokens.
" - } - }, - "documentation":"Input to the GetCredentialsForIdentity action.
A unique identifier in the format REGION:GUID.
" - }, - "Credentials":{ - "shape":"Credentials", - "documentation":"Credentials for the the provided identity ID.
" - } - }, - "documentation":"Returned in response to a successful GetCredentialsForIdentity operation.
A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
graph.facebook.com accounts.google.com www.amazon.com An identity pool ID in the format REGION:GUID.
" - } - }, - "documentation":"Input to the GetIdentityPoolRoles action.
An identity pool ID in the format REGION:GUID.
" - }, - "Roles":{ - "shape":"RolesMap", - "documentation":"The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
" - } - }, - "documentation":"Returned in response to a successful GetIdentityPoolRoles operation.
An identity pool ID in the format REGION:GUID.
" - }, - "IdentityId":{ - "shape":"IdentityId", - "documentation":"A unique identifier in the format REGION:GUID.
" - }, - "Logins":{ - "shape":"LoginsMap", - "documentation":"A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax \"developer_provider_name\": \"developer_user_identifier\". The developer provider is the \"domain\" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
" - } - }, - "documentation":"Input to the GetOpenIdTokenForDeveloperIdentity action.
A unique identifier in the format REGION:GUID.
" - }, - "Token":{ - "shape":"OIDCToken", - "documentation":"An OpenID token.
" - } - }, - "documentation":"Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.
Date on which the identity was created.
" - }, - "LastModifiedDate":{ - "shape":"DateType", - "documentation":"Date on which the identity was last modified.
" - } - }, - "documentation":"A description of the identity." - }, - "IdentityId":{ - "type":"string", - "min":1, - "max":50, - "pattern":"[\\w-]+:[0-9a-f-]+" - }, - "IdentityPool":{ - "type":"structure", - "required":[ - "IdentityPoolId", - "IdentityPoolName", - "AllowUnauthenticatedIdentities" - ], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - }, - "IdentityPoolName":{ - "shape":"IdentityPoolName", - "documentation":"A string that you provide.
" - }, - "AllowUnauthenticatedIdentities":{ - "shape":"IdentityPoolUnauthenticated", - "documentation":"TRUE if the identity pool supports unauthenticated logins." - }, - "SupportedLoginProviders":{ - "shape":"IdentityProviders", - "documentation":"Optional key:value pairs mapping provider names to provider app IDs.
" - }, - "DeveloperProviderName":{ - "shape":"DeveloperProviderName", - "documentation":"The \"domain\" by which Cognito will refer to your users.
" - }, - "OpenIdConnectProviderARNs":{ - "shape":"OIDCProviderList", - "documentation":"A list of OpendID Connect provider ARNs.
" - } - }, - "documentation":"An object representing a Cognito identity pool." - }, - "IdentityPoolId":{ - "type":"string", - "min":1, - "max":50, - "pattern":"[\\w-]+:[0-9a-f-]+" - }, - "IdentityPoolName":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w ]+" - }, - "IdentityPoolShortDescription":{ - "type":"structure", - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - }, - "IdentityPoolName":{ - "shape":"IdentityPoolName", - "documentation":"A string that you provide." - } - }, - "documentation":"A description of the identity pool." - }, - "IdentityPoolUnauthenticated":{"type":"boolean"}, - "IdentityPoolsList":{ - "type":"list", - "member":{"shape":"IdentityPoolShortDescription"} - }, - "IdentityProviderId":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w._-]+" - }, - "IdentityProviderName":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w._-]+" - }, - "IdentityProviderToken":{ - "type":"string", - "min":1, - "max":2048, - "pattern":"[\\S]+" - }, - "IdentityProviders":{ - "type":"map", - "key":{"shape":"IdentityProviderName"}, - "value":{"shape":"IdentityProviderId"}, - "max":10 - }, - "InternalErrorException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The message returned by an InternalErrorException." - } - }, - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - }, - "InvalidIdentityPoolConfigurationException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The message returned for an InvalidIdentityPoolConfigurationException
Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
" - }, - "InvalidParameterException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The message returned by an InvalidParameterException." - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown for missing or bad input parameter(s)." - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The message returned by a LimitExceededException." - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Thrown when the total number of user pools has exceeded a preset limit." - }, - "ListIdentitiesInput":{ - "type":"structure", - "required":[ - "IdentityPoolId", - "MaxResults" - ], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - }, - "MaxResults":{ - "shape":"QueryLimit", - "documentation":"The maximum number of identities to return." - }, - "NextToken":{ - "shape":"PaginationKey", - "documentation":"A pagination token." - } - }, - "documentation":"Input to the ListIdentities action." - }, - "ListIdentitiesResponse":{ - "type":"structure", - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - }, - "Identities":{ - "shape":"IdentitiesList", - "documentation":"An object containing a set of identities and associated mappings." - }, - "NextToken":{ - "shape":"PaginationKey", - "documentation":"A pagination token." - } - }, - "documentation":"The response to a ListIdentities request." - }, - "ListIdentityPoolsInput":{ - "type":"structure", - "required":["MaxResults"], - "members":{ - "MaxResults":{ - "shape":"QueryLimit", - "documentation":"The maximum number of identities to return." - }, - "NextToken":{ - "shape":"PaginationKey", - "documentation":"A pagination token." - } - }, - "documentation":"Input to the ListIdentityPools action." - }, - "ListIdentityPoolsResponse":{ - "type":"structure", - "members":{ - "IdentityPools":{ - "shape":"IdentityPoolsList", - "documentation":"The identity pools returned by the ListIdentityPools action." - }, - "NextToken":{ - "shape":"PaginationKey", - "documentation":"A pagination token." - } - }, - "documentation":"The result of a successful ListIdentityPools action." - }, - "LoginsList":{ - "type":"list", - "member":{"shape":"IdentityProviderName"} - }, - "LoginsMap":{ - "type":"map", - "key":{"shape":"IdentityProviderName"}, - "value":{"shape":"IdentityProviderToken"}, - "max":10 - }, - "LookupDeveloperIdentityInput":{ - "type":"structure", - "required":["IdentityPoolId"], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID.
" - }, - "IdentityId":{ - "shape":"IdentityId", - "documentation":"A unique identifier in the format REGION:GUID.
" - }, - "DeveloperUserIdentifier":{ - "shape":"DeveloperUserIdentifier", - "documentation":"A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
" - }, - "MaxResults":{ - "shape":"QueryLimit", - "documentation":"The maximum number of identities to return.
" - }, - "NextToken":{ - "shape":"PaginationKey", - "documentation":"A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
Input to the LookupDeveloperIdentityInput action.
A unique identifier in the format REGION:GUID.
" - }, - "DeveloperUserIdentifierList":{ - "shape":"DeveloperUserIdentifierList", - "documentation":"This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
" - }, - "NextToken":{ - "shape":"PaginationKey", - "documentation":"A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
Returned in response to a successful LookupDeveloperIdentity action.
User identifier for the source user. The value should be a DeveloperUserIdentifier.
User identifier for the destination user. The value should be a DeveloperUserIdentifier.
The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
An identity pool ID in the format REGION:GUID.
" - } - }, - "documentation":"Input to the MergeDeveloperIdentities action.
A unique identifier in the format REGION:GUID.
" - } - }, - "documentation":"Returned in response to a successful MergeDeveloperIdentities action.
An identity pool ID in the format REGION:GUID.
" - }, - "Roles":{ - "shape":"RolesMap", - "documentation":"The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
" - } - }, - "documentation":"Input to the SetIdentityPoolRoles action.
A unique identifier in the format REGION:GUID.
" - }, - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID.
" - }, - "DeveloperProviderName":{ - "shape":"DeveloperProviderName", - "documentation":"The \"domain\" by which Cognito will refer to your users.
" - }, - "DeveloperUserIdentifier":{ - "shape":"DeveloperUserIdentifier", - "documentation":"A unique ID used by your backend authentication process to identify a user." - } - }, - "documentation":"Input to the UnlinkDeveloperIdentity action.
Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.
", - "operations":{ - "DeleteDataset":{ - "name":"DeleteDataset", - "http":{ - "method":"DELETE", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", - "responseCode":200 - }, - "input":{ - "shape":"DeleteDatasetRequest", - "documentation":"A request to delete the specific dataset." - }, - "output":{ - "shape":"DeleteDatasetResponse", - "documentation":"Response to a successful DeleteDataset request." - }, - "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any consequent operation on this dataset will result in a ResourceNotFoundException." - }, - "DescribeDataset":{ - "name":"DescribeDataset", - "http":{ - "method":"GET", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", - "responseCode":200 - }, - "input":{ - "shape":"DescribeDatasetRequest", - "documentation":"A request for metadata about a dataset (creation date, number of records, size) by owner and dataset name." - }, - "output":{ - "shape":"DescribeDatasetResponse", - "documentation":"Response to a successful DescribeDataset request." - }, - "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Gets metadata about a dataset by identity and dataset name. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." - }, - "DescribeIdentityPoolUsage":{ - "name":"DescribeIdentityPoolUsage", - "http":{ - "method":"GET", - "requestUri":"/identitypools/{IdentityPoolId}", - "responseCode":200 - }, - "input":{ - "shape":"DescribeIdentityPoolUsageRequest", - "documentation":"A request for usage information about the identity pool." - }, - "output":{ - "shape":"DescribeIdentityPoolUsageResponse", - "documentation":"Response to a successful DescribeIdentityPoolUsage request." - }, - "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Gets usage details (for example, data storage) about a particular identity pool." - }, - "DescribeIdentityUsage":{ - "name":"DescribeIdentityUsage", - "http":{ - "method":"GET", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}", - "responseCode":200 - }, - "input":{ - "shape":"DescribeIdentityUsageRequest", - "documentation":"A request for information about the usage of an identity pool." - }, - "output":{ - "shape":"DescribeIdentityUsageResponse", - "documentation":"The response to a successful DescribeIdentityUsage request." - }, - "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Gets usage information for an identity, including number of datasets and data usage." - }, - "GetIdentityPoolConfiguration":{ - "name":"GetIdentityPoolConfiguration", - "http":{ - "method":"GET", - "requestUri":"/identitypools/{IdentityPoolId}/configuration", - "responseCode":200 - }, - "input":{ - "shape":"GetIdentityPoolConfigurationRequest", - "documentation":"A request to GetIdentityPoolConfigurationRequest.
The response from GetIdentityPoolConfigurationResponse.
Gets the configuration settings of an identity pool.
" - }, - "ListDatasets":{ - "name":"ListDatasets", - "http":{ - "method":"GET", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", - "responseCode":200 - }, - "input":{ - "shape":"ListDatasetsRequest", - "documentation":"Request for a list of datasets for an identity." - }, - "output":{ - "shape":"ListDatasetsResponse", - "documentation":"Returned for a successful ListDatasets request." - }, - "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Lists datasets for an identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." - }, - "ListIdentityPoolUsage":{ - "name":"ListIdentityPoolUsage", - "http":{ - "method":"GET", - "requestUri":"/identitypools", - "responseCode":200 - }, - "input":{ - "shape":"ListIdentityPoolUsageRequest", - "documentation":"A request for usage information on an identity pool." - }, - "output":{ - "shape":"ListIdentityPoolUsageResponse", - "documentation":"Returned for a successful ListIdentityPoolUsage request." - }, - "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Gets a list of identity pools registered with Cognito." - }, - "ListRecords":{ - "name":"ListRecords", - "http":{ - "method":"GET", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", - "responseCode":200 - }, - "input":{ - "shape":"ListRecordsRequest", - "documentation":"A request for a list of records." - }, - "output":{ - "shape":"ListRecordsResponse", - "documentation":"Returned for a successful ListRecordsRequest." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Gets paginated records, optionally changed after a particular sync count for a dataset and identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." - }, - "RegisterDevice":{ - "name":"RegisterDevice", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/identity/{IdentityId}/device", - "responseCode":200 - }, - "input":{ - "shape":"RegisterDeviceRequest", - "documentation":"A request to RegisterDevice.
Response to a RegisterDevice request.
Registers a device to receive push sync notifications.
" - }, - "SetIdentityPoolConfiguration":{ - "name":"SetIdentityPoolConfiguration", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/configuration", - "responseCode":200 - }, - "input":{ - "shape":"SetIdentityPoolConfigurationRequest", - "documentation":"A request to SetIdentityPoolConfiguration.
Response to a SetIdentityPoolConfiguration request.
Sets the necessary configuration for push sync.
" - }, - "SubscribeToDataset":{ - "name":"SubscribeToDataset", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", - "responseCode":200 - }, - "input":{ - "shape":"SubscribeToDatasetRequest", - "documentation":"A request to SubscribeToDatasetRequest.
Response to a SubscribeToDataset request.
Subscribes to receive notifications when a dataset is modified by another device.
" - }, - "UnsubscribeFromDataset":{ - "name":"UnsubscribeFromDataset", - "http":{ - "method":"DELETE", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", - "responseCode":200 - }, - "input":{ - "shape":"UnsubscribeFromDatasetRequest", - "documentation":"A request to UnsubscribeFromDataset.
Response to an UnsubscribeFromDataset request.
Unsubscribe from receiving notifications when a dataset is modified by another device.
" - }, - "UpdateRecords":{ - "name":"UpdateRecords", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", - "responseCode":200 - }, - "input":{ - "shape":"UpdateRecordsRequest", - "documentation":"A request to post updates to records or add and delete records for a dataset and user." - }, - "output":{ - "shape":"UpdateRecordsResponse", - "documentation":"Returned for a successful UpdateRecordsRequest." - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." - }, - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"ResourceConflictException", - "error":{ - "code":"ResourceConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } - ], - "documentation":"Posts updates to records and add and delete records for a dataset and user. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call." - } - }, - "shapes":{ - "ApplicationArn":{ - "type":"string", - "pattern":"arn:aws:sns:[-0-9a-z]+:\\d+:app/[A-Z_]+/[a-zA-Z0-9_.-]+" - }, - "ApplicationArnList":{ - "type":"list", - "member":{"shape":"ApplicationArn"} - }, - "AssumeRoleArn":{ - "type":"string", - "min":20, - "max":2048, - "pattern":"arn:aws:iam::\\d+:role/.*" - }, - "Boolean":{"type":"boolean"}, - "ClientContext":{"type":"string"}, - "Dataset":{ - "type":"structure", - "members":{ - "IdentityId":{ - "shape":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - }, - "DatasetName":{ - "shape":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." - }, - "CreationDate":{ - "shape":"Date", - "documentation":"Date on which the dataset was created." - }, - "LastModifiedDate":{ - "shape":"Date", - "documentation":"Date when the dataset was last modified." - }, - "LastModifiedBy":{ - "shape":"String", - "documentation":"The device that made the last change to this dataset." - }, - "DataStorage":{ - "shape":"Long", - "documentation":"Total size in bytes of the records in this dataset." - }, - "NumRecords":{ - "shape":"Long", - "documentation":"Number of records in this dataset." - } - }, - "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." - }, - "DatasetList":{ - "type":"list", - "member":{"shape":"Dataset"} - }, - "DatasetName":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[a-zA-Z0-9_.:-]+" - }, - "Date":{"type":"timestamp"}, - "DeleteDatasetRequest":{ - "type":"structure", - "required":[ - "IdentityPoolId", - "IdentityId", - "DatasetName" - ], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - }, - "IdentityId":{ - "shape":"IdentityId", - "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - }, - "DatasetName":{ - "shape":"DatasetName", - "location":"uri", - "locationName":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." - } - }, - "documentation":"A request to delete the specific dataset." - }, - "DeleteDatasetResponse":{ - "type":"structure", - "members":{ - "Dataset":{ - "shape":"Dataset", - "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." - } - }, - "documentation":"Response to a successful DeleteDataset request." - }, - "DescribeDatasetRequest":{ - "type":"structure", - "required":[ - "IdentityPoolId", - "IdentityId", - "DatasetName" - ], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - }, - "IdentityId":{ - "shape":"IdentityId", - "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - }, - "DatasetName":{ - "shape":"DatasetName", - "location":"uri", - "locationName":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." - } - }, - "documentation":"A request for metadata about a dataset (creation date, number of records, size) by owner and dataset name." - }, - "DescribeDatasetResponse":{ - "type":"structure", - "members":{ - "Dataset":{ - "shape":"Dataset", - "documentation":"Metadata for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." - } - }, - "documentation":"Response to a successful DescribeDataset request." - }, - "DescribeIdentityPoolUsageRequest":{ - "type":"structure", - "required":["IdentityPoolId"], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - } - }, - "documentation":"A request for usage information about the identity pool." - }, - "DescribeIdentityPoolUsageResponse":{ - "type":"structure", - "members":{ - "IdentityPoolUsage":{ - "shape":"IdentityPoolUsage", - "documentation":"Information about the usage of the identity pool." - } - }, - "documentation":"Response to a successful DescribeIdentityPoolUsage request." - }, - "DescribeIdentityUsageRequest":{ - "type":"structure", - "required":[ - "IdentityPoolId", - "IdentityId" - ], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - }, - "IdentityId":{ - "shape":"IdentityId", - "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." - } - }, - "documentation":"A request for information about the usage of an identity pool." - }, - "DescribeIdentityUsageResponse":{ - "type":"structure", - "members":{ - "IdentityUsage":{ - "shape":"IdentityUsage", - "documentation":"Usage information for the identity." - } - }, - "documentation":"The response to a successful DescribeIdentityUsage request." - }, - "DeviceId":{ - "type":"string", - "min":1, - "max":256 - }, - "ExceptionMessage":{"type":"string"}, - "GetIdentityPoolConfigurationRequest":{ - "type":"structure", - "required":["IdentityPoolId"], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.
" - } - }, - "documentation":"A request to GetIdentityPoolConfigurationRequest.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
" - }, - "PushSync":{ - "shape":"PushSync", - "documentation":"Configuration options applied to the identity pool.
" - } - }, - "documentation":"The response from GetIdentityPoolConfigurationResponse.
List of SNS platform application ARNs that could be used by clients.
" - }, - "RoleArn":{ - "shape":"AssumeRoleArn", - "documentation":"A role configured to allow Cognito to call SNS on behalf of the developer.
" - } - }, - "documentation":"Configuration options to be applied to the identity pool.
" - }, - "PushToken":{"type":"string"}, - "Record":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"RecordKey", - "documentation":"The key for the record." - }, - "Value":{ - "shape":"RecordValue", - "documentation":"The value for the record." - }, - "SyncCount":{ - "shape":"Long", - "documentation":"The server sync count for this record." - }, - "LastModifiedDate":{ - "shape":"Date", - "documentation":"The date on which the record was last modified." - }, - "LastModifiedBy":{ - "shape":"String", - "documentation":"The user/device that made the last change to this record." - }, - "DeviceLastModifiedDate":{ - "shape":"Date", - "documentation":"The last modified date of the client device." - } - }, - "documentation":"The basic data structure of a dataset." - }, - "RecordKey":{ - "type":"string", - "min":1, - "max":1024 - }, - "RecordList":{ - "type":"list", - "member":{"shape":"Record"} - }, - "RecordPatch":{ - "type":"structure", - "required":[ - "Op", - "Key", - "SyncCount" - ], - "members":{ - "Op":{ - "shape":"Operation", - "documentation":"An operation, either replace or remove." - }, - "Key":{ - "shape":"RecordKey", - "documentation":"The key associated with the record patch." - }, - "Value":{ - "shape":"RecordValue", - "documentation":"The value associated with the record patch." - }, - "SyncCount":{ - "shape":"Long", - "documentation":"Last known server sync count for this record. Set to 0 if unknown." - }, - "DeviceLastModifiedDate":{ - "shape":"Date", - "documentation":"The last modified date of the client device." - } - }, - "documentation":"An update operation for a record." - }, - "RecordPatchList":{ - "type":"list", - "member":{"shape":"RecordPatch"} - }, - "RecordValue":{ - "type":"string", - "max":1048575 - }, - "RegisterDeviceRequest":{ - "type":"structure", - "required":[ - "IdentityPoolId", - "IdentityId", - "Platform", - "Token" - ], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.
" - }, - "IdentityId":{ - "shape":"IdentityId", - "location":"uri", - "locationName":"IdentityId", - "documentation":"The unique ID for this identity.
" - }, - "Platform":{ - "shape":"Platform", - "documentation":"The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
" - }, - "Token":{ - "shape":"PushToken", - "documentation":"The push token.
" - } - }, - "documentation":"A request to RegisterDevice.
The unique ID generated for this device by Cognito.
" - } - }, - "documentation":"Response to a RegisterDevice request.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.
" - }, - "PushSync":{ - "shape":"PushSync", - "documentation":"Configuration options to be applied to the identity pool.
" - } - }, - "documentation":"A request to SetIdentityPoolConfiguration.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
" - }, - "PushSync":{ - "shape":"PushSync", - "documentation":"Configuration options applied to the identity pool.
" - } - }, - "documentation":"Response to a SetIdentityPoolConfiguration request.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.
" - }, - "IdentityId":{ - "shape":"IdentityId", - "location":"uri", - "locationName":"IdentityId", - "documentation":"Unique ID for this identity.
" - }, - "DatasetName":{ - "shape":"DatasetName", - "location":"uri", - "locationName":"DatasetName", - "documentation":"The name of the dataset to subcribe to.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "location":"uri", - "locationName":"DeviceId", - "documentation":"The unique ID generated for this device by Cognito.
" - } - }, - "documentation":"A request to SubscribeToDatasetRequest.
Response to a SubscribeToDataset request.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
" - }, - "IdentityId":{ - "shape":"IdentityId", - "location":"uri", - "locationName":"IdentityId", - "documentation":"Unique ID for this identity.
" - }, - "DatasetName":{ - "shape":"DatasetName", - "location":"uri", - "locationName":"DatasetName", - "documentation":"The name of the dataset from which to unsubcribe.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "location":"uri", - "locationName":"DeviceId", - "documentation":"The unique ID generated for this device by Cognito.
" - } - }, - "documentation":"A request to UnsubscribeFromDataset.
Response to an UnsubscribeFromDataset request.
The unique ID generated for this device by Cognito.
" - }, - "RecordPatches":{ - "shape":"RecordPatchList", - "documentation":"A list of patch operations." - }, - "SyncSessionToken":{ - "shape":"SyncSessionToken", - "documentation":"The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity." - }, - "ClientContext":{ - "shape":"ClientContext", - "location":"header", - "locationName":"x-amz-Client-Context", - "documentation":"Intended to supply a device ID that will populate thelastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented."
- }
- },
- "documentation":"A request to post updates to records or add and delete records for a dataset and user."
- },
- "UpdateRecordsResponse":{
- "type":"structure",
- "members":{
- "Records":{
- "shape":"RecordList",
- "documentation":"A list of records that have been updated."
- }
- },
- "documentation":"Returned for a successful UpdateRecordsRequest."
- }
- }
-}
diff --git a/src/github.com/getlantern/aws-sdk-go/apis/config/2014-11-12.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/config/2014-11-12.normal.json
deleted file mode 100644
index 29f0d8e3d7..0000000000
--- a/src/github.com/getlantern/aws-sdk-go/apis/config/2014-11-12.normal.json
+++ /dev/null
@@ -1,1038 +0,0 @@
-{
- "metadata":{
- "apiVersion":"2014-11-12",
- "endpointPrefix":"config",
- "jsonVersion":"1.1",
- "serviceAbbreviation":"Config Service",
- "serviceFullName":"AWS Config",
- "signatureVersion":"v4",
- "signingName":"config",
- "targetPrefix":"StarlingDoveService",
- "protocol":"json"
- },
- "documentation":"AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources.
You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config
This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.
The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process.
For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config? in the AWS Config Developer Guide.
", - "operations":{ - "DeleteDeliveryChannel":{ - "name":"DeleteDeliveryChannel", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDeliveryChannelRequest", - "documentation":"The input for the DeleteDeliveryChannel action. The action accepts the following data in JSON format.
" - }, - "errors":[ - { - "shape":"NoSuchDeliveryChannelException", - "exception":true, - "documentation":"You have specified a delivery channel that does not exist.
" - }, - { - "shape":"LastDeliveryChannelDeleteFailedException", - "exception":true, - "documentation":"You cannot delete the delivery channel you specified because the configuration recorder is running.
" - } - ], - "documentation":"Deletes the specified delivery channel.
The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action.
" - }, - "DeliverConfigSnapshot":{ - "name":"DeliverConfigSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeliverConfigSnapshotRequest", - "documentation":"The input for the DeliverConfigSnapshot action.
" - }, - "output":{ - "shape":"DeliverConfigSnapshotResponse", - "documentation":"The output for the DeliverConfigSnapshot action in JSON format.
" - }, - "errors":[ - { - "shape":"NoSuchDeliveryChannelException", - "exception":true, - "documentation":"You have specified a delivery channel that does not exist.
" - }, - { - "shape":"NoAvailableConfigurationRecorderException", - "exception":true, - "documentation":"There are no configuration recorders available to provide the role needed to describe your resources.
" - }, - { - "shape":"NoRunningConfigurationRecorderException", - "exception":true, - "documentation":"There is no configuration recorder running.
" - } - ], - "documentation":"Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
The input for the DescribeConfigurationRecorderStatus action.
" - }, - "output":{ - "shape":"DescribeConfigurationRecorderStatusResponse", - "documentation":"The output for the DescribeConfigurationRecorderStatus action in JSON format.
" - }, - "errors":[ - { - "shape":"NoSuchConfigurationRecorderException", - "exception":true, - "documentation":"You have specified a configuration recorder that does not exist.
" - } - ], - "documentation":"Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
" - }, - "DescribeConfigurationRecorders":{ - "name":"DescribeConfigurationRecorders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeConfigurationRecordersRequest", - "documentation":"The input for the DescribeConfigurationRecorders action.
" - }, - "output":{ - "shape":"DescribeConfigurationRecordersResponse", - "documentation":"The output for the DescribeConfigurationRecorders action.
" - }, - "errors":[ - { - "shape":"NoSuchConfigurationRecorderException", - "exception":true, - "documentation":"You have specified a configuration recorder that does not exist.
" - } - ], - "documentation":"Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.
" - }, - "DescribeDeliveryChannelStatus":{ - "name":"DescribeDeliveryChannelStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDeliveryChannelStatusRequest", - "documentation":"The input for the DeliveryChannelStatus action.
" - }, - "output":{ - "shape":"DescribeDeliveryChannelStatusResponse", - "documentation":"The output for the DescribeDeliveryChannelStatus action.
" - }, - "errors":[ - { - "shape":"NoSuchDeliveryChannelException", - "exception":true, - "documentation":"You have specified a delivery channel that does not exist.
" - } - ], - "documentation":"Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
" - }, - "DescribeDeliveryChannels":{ - "name":"DescribeDeliveryChannels", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDeliveryChannelsRequest", - "documentation":"The input for the DescribeDeliveryChannels action.
" - }, - "output":{ - "shape":"DescribeDeliveryChannelsResponse", - "documentation":"The output for the DescribeDeliveryChannels action.
" - }, - "errors":[ - { - "shape":"NoSuchDeliveryChannelException", - "exception":true, - "documentation":"You have specified a delivery channel that does not exist.
" - } - ], - "documentation":"Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
" - }, - "GetResourceConfigHistory":{ - "name":"GetResourceConfigHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetResourceConfigHistoryRequest", - "documentation":"The input for the GetResourceConfigHistory action.
" - }, - "output":{ - "shape":"GetResourceConfigHistoryResponse", - "documentation":"The output for the GetResourceConfigHistory action.
" - }, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"The requested action is not valid.
" - }, - { - "shape":"InvalidTimeRangeException", - "exception":true, - "documentation":"The specified time range is not valid. The earlier time is not chronologically before the later time.
" - }, - { - "shape":"InvalidLimitException", - "exception":true, - "documentation":"You have reached the limit on the pagination.
" - }, - { - "shape":"InvalidNextTokenException", - "exception":true, - "documentation":"The specified nextToken for pagination is not valid.
" - }, - { - "shape":"NoAvailableConfigurationRecorderException", - "exception":true, - "documentation":"There are no configuration recorders available to provide the role needed to describe your resources.
" - }, - { - "shape":"ResourceNotDiscoveredException", - "exception":true, - "documentation":"You have specified a resource that is either unknown or has not been discovered.
" - } - ], - "documentation":"Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. You can specify a limit on the number of results returned on the page. If a limit is specified, a nextToken is returned as part of the result that you can use to continue this request.
The input for the PutConfigurationRecorder action.
" - }, - "errors":[ - { - "shape":"MaxNumberOfConfigurationRecordersExceededException", - "exception":true, - "documentation":"You have reached the limit on the number of recorders you can create.
" - }, - { - "shape":"InvalidConfigurationRecorderNameException", - "exception":true, - "documentation":"You have provided a configuration recorder name that is not valid.
" - }, - { - "shape":"InvalidRoleException", - "exception":true, - "documentation":"You have provided a null or empty role ARN.
" - } - ], - "documentation":"Creates a new configuration recorder to record the resource configurations.
You can use this action to change the role (roleARN) of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.
The input for the PutDeliveryChannel action.
" - }, - "errors":[ - { - "shape":"MaxNumberOfDeliveryChannelsExceededException", - "exception":true, - "documentation":"You have reached the limit on the number of delivery channels you can create.
" - }, - { - "shape":"NoAvailableConfigurationRecorderException", - "exception":true, - "documentation":"There are no configuration recorders available to provide the role needed to describe your resources.
" - }, - { - "shape":"InvalidDeliveryChannelNameException", - "exception":true, - "documentation":"The specified delivery channel name is not valid.
" - }, - { - "shape":"NoSuchBucketException", - "exception":true, - "documentation":"The specified Amazon S3 bucket does not exist.
" - }, - { - "shape":"InvalidS3KeyPrefixException", - "exception":true, - "documentation":"The specified Amazon S3 key prefix is not valid.
" - }, - { - "shape":"InvalidSNSTopicARNException", - "exception":true, - "documentation":"The specified Amazon SNS topic does not exist.
" - }, - { - "shape":"InsufficientDeliveryPolicyException", - "exception":true, - "documentation":"Your Amazon S3 bucket policy does not permit AWS Config to write to it.
" - } - ], - "documentation":"Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
" - }, - "StartConfigurationRecorder":{ - "name":"StartConfigurationRecorder", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"StartConfigurationRecorderRequest", - "documentation":"The input for the StartConfigurationRecorder action.
" - }, - "errors":[ - { - "shape":"NoSuchConfigurationRecorderException", - "exception":true, - "documentation":"You have specified a configuration recorder that does not exist.
" - }, - { - "shape":"NoAvailableDeliveryChannelException", - "exception":true, - "documentation":"There is no delivery channel available to record configurations.
" - } - ], - "documentation":"Starts recording configurations of all the resources associated with the account.
You must have created at least one delivery channel to successfully start the configuration recorder.
" - }, - "StopConfigurationRecorder":{ - "name":"StopConfigurationRecorder", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"StopConfigurationRecorderRequest", - "documentation":"The input for the StopConfigurationRecorder action.
" - }, - "errors":[ - { - "shape":"NoSuchConfigurationRecorderException", - "exception":true, - "documentation":"You have specified a configuration recorder that does not exist.
" - } - ], - "documentation":"Stops recording configurations of all the resources associated with the account.
" - } - }, - "shapes":{ - "ARN":{"type":"string"}, - "AccountId":{"type":"string"}, - "AvailabilityZone":{"type":"string"}, - "Boolean":{"type":"boolean"}, - "ChannelName":{ - "type":"string", - "min":1, - "max":256 - }, - "ChronologicalOrder":{ - "type":"string", - "enum":[ - "Reverse", - "Forward" - ] - }, - "ConfigExportDeliveryInfo":{ - "type":"structure", - "members":{ - "lastStatus":{ - "shape":"DeliveryStatus", - "documentation":"Status of the last attempted delivery.
" - }, - "lastErrorCode":{ - "shape":"String", - "documentation":"The error code from the last attempted delivery.
" - }, - "lastErrorMessage":{ - "shape":"String", - "documentation":"The error message from the last attempted delivery.
" - }, - "lastAttemptTime":{ - "shape":"Date", - "documentation":"The time of the last attempted delivery.
" - }, - "lastSuccessfulTime":{ - "shape":"Date", - "documentation":"The time of the last successful delivery.
" - } - }, - "documentation":"A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket.
" - }, - "ConfigStreamDeliveryInfo":{ - "type":"structure", - "members":{ - "lastStatus":{ - "shape":"DeliveryStatus", - "documentation":"Status of the last attempted delivery.
" - }, - "lastErrorCode":{ - "shape":"String", - "documentation":"The error code from the last attempted delivery.
" - }, - "lastErrorMessage":{ - "shape":"String", - "documentation":"The error message from the last attempted delivery.
" - }, - "lastStatusChangeTime":{ - "shape":"Date", - "documentation":"The time from the last status change.
" - } - }, - "documentation":"A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.
" - }, - "Configuration":{"type":"string"}, - "ConfigurationItem":{ - "type":"structure", - "members":{ - "version":{ - "shape":"Version", - "documentation":"The version number of the resource configuration.
" - }, - "accountId":{ - "shape":"AccountId", - "documentation":"The 12 digit AWS account ID associated with the resource.
" - }, - "configurationItemCaptureTime":{ - "shape":"ConfigurationItemCaptureTime", - "documentation":"The time when the configuration recording was initiated.
" - }, - "configurationItemStatus":{ - "shape":"ConfigurationItemStatus", - "documentation":"The configuration item status.
" - }, - "configurationStateId":{ - "shape":"ConfigurationStateId", - "documentation":"An identifier that indicates the ordering of the configuration items of a resource.
" - }, - "configurationItemMD5Hash":{ - "shape":"ConfigurationItemMD5Hash", - "documentation":"Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
" - }, - "arn":{ - "shape":"ARN", - "documentation":"The Amazon Resource Name (ARN) of the resource.
" - }, - "resourceType":{ - "shape":"ResourceType", - "documentation":"The type of AWS resource.
" - }, - "resourceId":{ - "shape":"ResourceId", - "documentation":"The ID of the resource (for example., sg-xxxxxx).
The Availability Zone associated with the resource.
" - }, - "resourceCreationTime":{ - "shape":"ResourceCreationTime", - "documentation":"The time stamp when the resource was created.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"A mapping of key value tags associated with the resource.
" - }, - "relatedEvents":{ - "shape":"RelatedEventList", - "documentation":"A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What is AWS CloudTrail?.
An empty field indicates that the current configuration was not initiated by any event.
" - }, - "relationships":{ - "shape":"RelationshipList", - "documentation":"A list of related AWS resources.
" - }, - "configuration":{ - "shape":"Configuration", - "documentation":"The description of the resource configuration.
" - } - }, - "documentation":"A list that contains detailed configurations of a specified resource.
" - }, - "ConfigurationItemCaptureTime":{"type":"timestamp"}, - "ConfigurationItemList":{ - "type":"list", - "member":{"shape":"ConfigurationItem"} - }, - "ConfigurationItemMD5Hash":{"type":"string"}, - "ConfigurationItemStatus":{ - "type":"string", - "enum":[ - "Ok", - "Failed", - "Discovered", - "Deleted" - ] - }, - "ConfigurationRecorder":{ - "type":"structure", - "members":{ - "name":{ - "shape":"RecorderName", - "documentation":"The name of the recorder. By default, AWS Config automatically assigns the name \"default\" when creating the configuration recorder. You cannot change the assigned name.
" - }, - "roleARN":{ - "shape":"String", - "documentation":"Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
" - } - }, - "documentation":"An object that represents the recording of configuration changes of an AWS resource.
" - }, - "ConfigurationRecorderList":{ - "type":"list", - "member":{"shape":"ConfigurationRecorder"} - }, - "ConfigurationRecorderNameList":{ - "type":"list", - "member":{"shape":"RecorderName"} - }, - "ConfigurationRecorderStatus":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the configuration recorder.
" - }, - "lastStartTime":{ - "shape":"Date", - "documentation":"The time the recorder was last started.
" - }, - "lastStopTime":{ - "shape":"Date", - "documentation":"The time the recorder was last stopped.
" - }, - "recording":{ - "shape":"Boolean", - "documentation":"Specifies whether the recorder is currently recording or not.
" - }, - "lastStatus":{ - "shape":"RecorderStatus", - "documentation":"The last (previous) status of the recorder.
" - }, - "lastErrorCode":{ - "shape":"String", - "documentation":"The error code indicating that the recording failed.
" - }, - "lastErrorMessage":{ - "shape":"String", - "documentation":"The message indicating that the recording failed due to an error.
" - }, - "lastStatusChangeTime":{ - "shape":"Date", - "documentation":"The time when the status was last changed.
" - } - }, - "documentation":"The current status of the configuration recorder.
" - }, - "ConfigurationRecorderStatusList":{ - "type":"list", - "member":{"shape":"ConfigurationRecorderStatus"} - }, - "ConfigurationStateId":{"type":"string"}, - "Date":{"type":"timestamp"}, - "DeleteDeliveryChannelRequest":{ - "type":"structure", - "required":["DeliveryChannelName"], - "members":{ - "DeliveryChannelName":{ - "shape":"ChannelName", - "documentation":"The name of the delivery channel to delete.
" - } - }, - "documentation":"The input for the DeleteDeliveryChannel action. The action accepts the following data in JSON format.
" - }, - "DeliverConfigSnapshotRequest":{ - "type":"structure", - "required":["deliveryChannelName"], - "members":{ - "deliveryChannelName":{ - "shape":"ChannelName", - "documentation":"The name of the delivery channel through which the snapshot is delivered.
" - } - }, - "documentation":"The input for the DeliverConfigSnapshot action.
" - }, - "DeliverConfigSnapshotResponse":{ - "type":"structure", - "members":{ - "configSnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot that is being created.
" - } - }, - "documentation":"The output for the DeliverConfigSnapshot action in JSON format.
" - }, - "DeliveryChannel":{ - "type":"structure", - "members":{ - "name":{ - "shape":"ChannelName", - "documentation":"The name of the delivery channel. By default, AWS Config automatically assigns the name \"default\" when creating the delivery channel. You cannot change the assigned name.
" - }, - "s3BucketName":{ - "shape":"String", - "documentation":"The name of the Amazon S3 bucket used to store configuration history for the delivery channel.
" - }, - "s3KeyPrefix":{ - "shape":"String", - "documentation":"The prefix for the specified Amazon S3 bucket.
" - }, - "snsTopicARN":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the IAM role used for accessing the Amazon S3 bucket and the Amazon SNS topic.
" - } - }, - "documentation":"A logical container used for storing the configuration changes of an AWS resource.
" - }, - "DeliveryChannelList":{ - "type":"list", - "member":{"shape":"DeliveryChannel"} - }, - "DeliveryChannelNameList":{ - "type":"list", - "member":{"shape":"ChannelName"} - }, - "DeliveryChannelStatus":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the delivery channel.
" - }, - "configSnapshotDeliveryInfo":{ - "shape":"ConfigExportDeliveryInfo", - "documentation":"A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
" - }, - "configHistoryDeliveryInfo":{ - "shape":"ConfigExportDeliveryInfo", - "documentation":"A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
" - }, - "configStreamDeliveryInfo":{ - "shape":"ConfigStreamDeliveryInfo", - "documentation":"A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
" - } - }, - "documentation":"The status of a specified delivery channel.
Valid values: Success | Failure
The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
" - } - }, - "documentation":"The input for the DescribeConfigurationRecorderStatus action.
" - }, - "DescribeConfigurationRecorderStatusResponse":{ - "type":"structure", - "members":{ - "ConfigurationRecordersStatus":{ - "shape":"ConfigurationRecorderStatusList", - "documentation":"A list that contains status of the specified recorders.
" - } - }, - "documentation":"The output for the DescribeConfigurationRecorderStatus action in JSON format.
" - }, - "DescribeConfigurationRecordersRequest":{ - "type":"structure", - "members":{ - "ConfigurationRecorderNames":{ - "shape":"ConfigurationRecorderNameList", - "documentation":"A list of configuration recorder names.
" - } - }, - "documentation":"The input for the DescribeConfigurationRecorders action.
" - }, - "DescribeConfigurationRecordersResponse":{ - "type":"structure", - "members":{ - "ConfigurationRecorders":{ - "shape":"ConfigurationRecorderList", - "documentation":"A list that contains the descriptions of the specified configuration recorders.
" - } - }, - "documentation":"The output for the DescribeConfigurationRecorders action.
" - }, - "DescribeDeliveryChannelStatusRequest":{ - "type":"structure", - "members":{ - "DeliveryChannelNames":{ - "shape":"DeliveryChannelNameList", - "documentation":"A list of delivery channel names.
" - } - }, - "documentation":"The input for the DeliveryChannelStatus action.
" - }, - "DescribeDeliveryChannelStatusResponse":{ - "type":"structure", - "members":{ - "DeliveryChannelsStatus":{ - "shape":"DeliveryChannelStatusList", - "documentation":"A list that contains the status of a specified delivery channel.
" - } - }, - "documentation":"The output for the DescribeDeliveryChannelStatus action.
" - }, - "DescribeDeliveryChannelsRequest":{ - "type":"structure", - "members":{ - "DeliveryChannelNames":{ - "shape":"DeliveryChannelNameList", - "documentation":"A list of delivery channel names.
" - } - }, - "documentation":"The input for the DescribeDeliveryChannels action.
" - }, - "DescribeDeliveryChannelsResponse":{ - "type":"structure", - "members":{ - "DeliveryChannels":{ - "shape":"DeliveryChannelList", - "documentation":"A list that contains the descriptions of the specified delivery channel.
" - } - }, - "documentation":"The output for the DescribeDeliveryChannels action.
" - }, - "EarlierTime":{"type":"timestamp"}, - "GetResourceConfigHistoryRequest":{ - "type":"structure", - "required":[ - "resourceType", - "resourceId" - ], - "members":{ - "resourceType":{ - "shape":"ResourceType", - "documentation":"The resource type.
" - }, - "resourceId":{ - "shape":"ResourceId", - "documentation":"The ID of the resource (for example., sg-xxxxxx).
The time stamp that indicates a later time. If not specified, current time is taken.
" - }, - "earlierTime":{ - "shape":"EarlierTime", - "documentation":"The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded.
" - }, - "chronologicalOrder":{ - "shape":"ChronologicalOrder", - "documentation":"The chronological order for configuration items listed. By default the results are listed in reverse chronological order.
" - }, - "limit":{ - "shape":"Limit", - "documentation":"The maximum number of configuration items returned in each page. The default is 10. You cannot specify a limit greater than 100.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"An optional parameter used for pagination of the results.
" - } - }, - "documentation":"The input for the GetResourceConfigHistory action.
" - }, - "GetResourceConfigHistoryResponse":{ - "type":"structure", - "members":{ - "configurationItems":{ - "shape":"ConfigurationItemList", - "documentation":"A list that contains the configuration history of one or more resources.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A token used for pagination of results.
" - } - }, - "documentation":"The output for the GetResourceConfigHistory action.
" - }, - "InsufficientDeliveryPolicyException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"Your Amazon S3 bucket policy does not permit AWS Config to write to it.
" - }, - "InvalidConfigurationRecorderNameException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have provided a configuration recorder name that is not valid.
" - }, - "InvalidDeliveryChannelNameException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified delivery channel name is not valid.
" - }, - "InvalidLimitException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have reached the limit on the pagination.
" - }, - "InvalidNextTokenException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified nextToken for pagination is not valid.
" - }, - "InvalidRoleException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have provided a null or empty role ARN.
" - }, - "InvalidS3KeyPrefixException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified Amazon S3 key prefix is not valid.
" - }, - "InvalidSNSTopicARNException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified Amazon SNS topic does not exist.
" - }, - "InvalidTimeRangeException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified time range is not valid. The earlier time is not chronologically before the later time.
" - }, - "LastDeliveryChannelDeleteFailedException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You cannot delete the delivery channel you specified because the configuration recorder is running.
" - }, - "LaterTime":{"type":"timestamp"}, - "Limit":{ - "type":"integer", - "min":0, - "max":100 - }, - "MaxNumberOfConfigurationRecordersExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have reached the limit on the number of recorders you can create.
" - }, - "MaxNumberOfDeliveryChannelsExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have reached the limit on the number of delivery channels you can create.
" - }, - "Name":{"type":"string"}, - "NextToken":{"type":"string"}, - "NoAvailableConfigurationRecorderException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"There are no configuration recorders available to provide the role needed to describe your resources.
" - }, - "NoAvailableDeliveryChannelException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"There is no delivery channel available to record configurations.
" - }, - "NoRunningConfigurationRecorderException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"There is no configuration recorder running.
" - }, - "NoSuchBucketException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified Amazon S3 bucket does not exist.
" - }, - "NoSuchConfigurationRecorderException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have specified a configuration recorder that does not exist.
" - }, - "NoSuchDeliveryChannelException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have specified a delivery channel that does not exist.
" - }, - "PutConfigurationRecorderRequest":{ - "type":"structure", - "required":["ConfigurationRecorder"], - "members":{ - "ConfigurationRecorder":{ - "shape":"ConfigurationRecorder", - "documentation":"The configuration recorder object that records each configuration change made to the resources.
" - } - }, - "documentation":"The input for the PutConfigurationRecorder action.
" - }, - "PutDeliveryChannelRequest":{ - "type":"structure", - "required":["DeliveryChannel"], - "members":{ - "DeliveryChannel":{ - "shape":"DeliveryChannel", - "documentation":"The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
" - } - }, - "documentation":"The input for the PutDeliveryChannel action.
" - }, - "RecorderName":{ - "type":"string", - "min":1, - "max":256 - }, - "RecorderStatus":{ - "type":"string", - "enum":[ - "Pending", - "Success", - "Failure" - ] - }, - "RelatedEvent":{"type":"string"}, - "RelatedEventList":{ - "type":"list", - "member":{"shape":"RelatedEvent"} - }, - "Relationship":{ - "type":"structure", - "members":{ - "resourceType":{ - "shape":"ResourceType", - "documentation":"The resource type of the related resource.
" - }, - "resourceId":{ - "shape":"ResourceId", - "documentation":"The resource ID of the related resource (for example, sg-xxxxxx.
The name of the related resource.
" - } - }, - "documentation":"The relationship of the related resource to the main resource.
" - }, - "RelationshipList":{ - "type":"list", - "member":{"shape":"Relationship"} - }, - "RelationshipName":{"type":"string"}, - "ResourceCreationTime":{"type":"timestamp"}, - "ResourceId":{"type":"string"}, - "ResourceNotDiscoveredException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"You have specified a resource that is either unknown or has not been discovered.
" - }, - "ResourceType":{ - "type":"string", - "enum":[ - "AWS::EC2::CustomerGateway", - "AWS::EC2::EIP", - "AWS::EC2::Instance", - "AWS::EC2::InternetGateway", - "AWS::EC2::NetworkAcl", - "AWS::EC2::NetworkInterface", - "AWS::EC2::RouteTable", - "AWS::EC2::SecurityGroup", - "AWS::EC2::Subnet", - "AWS::CloudTrail::Trail", - "AWS::EC2::Volume", - "AWS::EC2::VPC", - "AWS::EC2::VPNConnection", - "AWS::EC2::VPNGateway" - ] - }, - "StartConfigurationRecorderRequest":{ - "type":"structure", - "required":["ConfigurationRecorderName"], - "members":{ - "ConfigurationRecorderName":{ - "shape":"RecorderName", - "documentation":"The name of the recorder object that records each configuration change made to the resources.
" - } - }, - "documentation":"The input for the StartConfigurationRecorder action.
" - }, - "StopConfigurationRecorderRequest":{ - "type":"structure", - "required":["ConfigurationRecorderName"], - "members":{ - "ConfigurationRecorderName":{ - "shape":"RecorderName", - "documentation":"The name of the recorder object that records each configuration change made to the resources.
" - } - }, - "documentation":"The input for the StopConfigurationRecorder action.
" - }, - "String":{"type":"string"}, - "Tags":{ - "type":"map", - "key":{"shape":"Name"}, - "value":{"shape":"Value"} - }, - "ValidationException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The requested action is not valid.
" - }, - "Value":{"type":"string"}, - "Version":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/datapipeline/2012-10-29.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/datapipeline/2012-10-29.normal.json deleted file mode 100644 index 8e77638277..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/datapipeline/2012-10-29.normal.json +++ /dev/null @@ -1,1542 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-10-29", - "endpointPrefix":"datapipeline", - "jsonVersion":"1.1", - "serviceFullName":"AWS Data Pipeline", - "signatureVersion":"v4", - "targetPrefix":"DataPipeline", - "protocol":"json" - }, - "documentation":"AWS Data Pipeline is a web service that configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so your application can focus on processing the data.
The AWS Data Pipeline SDKs and CLI implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You perform these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.
The second set of actions are used by a task runner application that calls the AWS Data Pipeline API to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.
AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.
", - "operations":{ - "ActivatePipeline":{ - "name":"ActivatePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ActivatePipelineInput", - "documentation":"The input of the ActivatePipeline action.
" - }, - "output":{ - "shape":"ActivatePipelineOutput", - "documentation":"Contains the output from the ActivatePipeline action.
" - }, - "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails. You cannot perform this operation on FINISHED pipelines and attempting to do so will return an InvalidRequestException.
Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated.
" - }, - "CreatePipeline":{ - "name":"CreatePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreatePipelineInput", - "documentation":"The input for the CreatePipeline action.
" - }, - "output":{ - "shape":"CreatePipelineOutput", - "documentation":"Contains the output from the CreatePipeline action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.
" - }, - "DeletePipeline":{ - "name":"DeletePipeline", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeletePipelineInput", - "documentation":"The input for the DeletePipeline action.
" - }, - "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.
To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to Pause on individual components. Components that are paused by SetStatus can be resumed.
" - }, - "DescribeObjects":{ - "name":"DescribeObjects", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeObjectsInput", - "documentation":"The DescribeObjects action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results.
" - }, - "output":{ - "shape":"DescribeObjectsOutput", - "documentation":"If True, there are more results that can be returned in another call to DescribeObjects.
An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":"Returns the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
" - }, - "DescribePipelines":{ - "name":"DescribePipelines", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribePipelinesInput", - "documentation":"The input to the DescribePipelines action.
" - }, - "output":{ - "shape":"DescribePipelinesOutput", - "documentation":"Contains the output from the DescribePipelines action.
" - }, - "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.
To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action.
" - }, - "EvaluateExpression":{ - "name":"EvaluateExpression", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"EvaluateExpressionInput", - "documentation":"The input for the EvaluateExpression action.
" - }, - "output":{ - "shape":"EvaluateExpressionOutput", - "documentation":"Contains the output from the EvaluateExpression action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":"Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3.
" - }, - "GetPipelineDefinition":{ - "name":"GetPipelineDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetPipelineDefinitionInput", - "documentation":"The input for the GetPipelineDefinition action.
" - }, - "output":{ - "shape":"GetPipelineDefinitionOutput", - "documentation":"Contains the output from the GetPipelineDefinition action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":"Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.
" - }, - "ListPipelines":{ - "name":"ListPipelines", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListPipelinesInput", - "documentation":"The input to the ListPipelines action.
" - }, - "output":{ - "shape":"ListPipelinesOutput", - "documentation":"Contains the output from the ListPipelines action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.
" - }, - "PollForTask":{ - "name":"PollForTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PollForTaskInput", - "documentation":"The data type passed in as input to the PollForTask action.
" - }, - "output":{ - "shape":"PollForTaskOutput", - "documentation":"Contains the output from the PollForTask action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - } - ], - "documentation":"Task runners call this action to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.
If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this may take up to 90 seconds.
The input of the PutPipelineDefinition action.
" - }, - "output":{ - "shape":"PutPipelineDefinitionOutput", - "documentation":"Contains the output of the PutPipelineDefinition action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":"Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline.
PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
" - }, - "QueryObjects":{ - "name":"QueryObjects", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"QueryObjectsInput", - "documentation":"The input for the QueryObjects action.
" - }, - "output":{ - "shape":"QueryObjectsOutput", - "documentation":"Contains the output from the QueryObjects action.
" - }, - "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Queries a pipeline for the names of objects that match a specified set of conditions.
The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True, you should continue to call QueryObjects, passing in the returned value for marker, until HasMoreResults returns False.
The input for the ReportTaskProgress action.
" - }, - "output":{ - "shape":"ReportTaskProgressOutput", - "documentation":"Contains the output from the ReportTaskProgress action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":" Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds.
The input for the ReportTaskRunnerHeartbeat action.
" - }, - "output":{ - "shape":"ReportTaskRunnerHeartbeatOutput", - "documentation":"Contains the output from the ReportTaskRunnerHeartbeat action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.
" - }, - "SetStatus":{ - "name":"SetStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetStatusInput", - "documentation":"The input to the SetStatus action.
" - }, - "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } - ], - "documentation":"Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object, e.g. DataNode or Activity. You cannot perform this operation on FINISHED pipelines and attempting to do so will return an InvalidRequestException.
" - }, - "SetTaskStatus":{ - "name":"SetTaskStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetTaskStatusInput", - "documentation":"The input of the SetTaskStatus action.
" - }, - "output":{ - "shape":"SetTaskStatusOutput", - "documentation":"The output from the SetTaskStatus action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":"Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.
" - }, - "ValidatePipelineDefinition":{ - "name":"ValidatePipelineDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ValidatePipelineDefinitionInput", - "documentation":"The input of the ValidatePipelineDefinition action.
" - }, - "output":{ - "shape":"ValidatePipelineDefinitionOutput", - "documentation":"Contains the output from the ValidatePipelineDefinition action.
" - }, - "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } - ], - "documentation":"Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.
" - } - }, - "shapes":{ - "ActivatePipelineInput":{ - "type":"structure", - "required":["pipelineId"], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"The identifier of the pipeline to activate.
" - }, - "parameterValues":{ - "shape":"ParameterValueList", - "documentation":"Returns a list of parameter values to pass to the pipeline at activation.
" - } - }, - "documentation":"The input of the ActivatePipeline action.
" - }, - "ActivatePipelineOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"Contains the output from the ActivatePipeline action.
" - }, - "CreatePipelineInput":{ - "type":"structure", - "required":[ - "name", - "uniqueId" - ], - "members":{ - "name":{ - "shape":"id", - "documentation":"The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.
" - }, - "uniqueId":{ - "shape":"id", - "documentation":"A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.
" - }, - "description":{ - "shape":"string", - "documentation":"The description of the new pipeline.
" - } - }, - "documentation":"The input for the CreatePipeline action.
" - }, - "CreatePipelineOutput":{ - "type":"structure", - "required":["pipelineId"], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE.
" - } - }, - "documentation":"Contains the output from the CreatePipeline action.
" - }, - "DeletePipelineInput":{ - "type":"structure", - "required":["pipelineId"], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"The identifier of the pipeline to be deleted.
" - } - }, - "documentation":"The input for the DeletePipeline action.
" - }, - "DescribeObjectsInput":{ - "type":"structure", - "required":[ - "pipelineId", - "objectIds" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"Identifier of the pipeline that contains the object definitions.
" - }, - "objectIds":{ - "shape":"idList", - "documentation":"Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.
" - }, - "evaluateExpressions":{ - "shape":"boolean", - "documentation":"Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
" - }, - "marker":{ - "shape":"string", - "documentation":"The starting point for the results to be returned. The first time you call DescribeObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call DescribeObjects again and pass the marker value from the response to retrieve the next set of results.
The DescribeObjects action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results.
" - }, - "DescribeObjectsOutput":{ - "type":"structure", - "required":["pipelineObjects"], - "members":{ - "pipelineObjects":{ - "shape":"PipelineObjectList", - "documentation":"An array of object definitions that are returned by the call to DescribeObjects.
" - }, - "marker":{ - "shape":"string", - "documentation":"The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value.
" - }, - "hasMoreResults":{ - "shape":"boolean", - "documentation":"If True, there are more pages of results to return.
If True, there are more results that can be returned in another call to DescribeObjects.
Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.
" - } - }, - "documentation":"The input to the DescribePipelines action.
" - }, - "DescribePipelinesOutput":{ - "type":"structure", - "required":["pipelineDescriptionList"], - "members":{ - "pipelineDescriptionList":{ - "shape":"PipelineDescriptionList", - "documentation":"An array of descriptions returned for the specified pipelines.
" - } - }, - "documentation":"Contains the output from the DescribePipelines action.
" - }, - "EvaluateExpressionInput":{ - "type":"structure", - "required":[ - "pipelineId", - "objectId", - "expression" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"The identifier of the pipeline.
" - }, - "objectId":{ - "shape":"id", - "documentation":"The identifier of the object.
" - }, - "expression":{ - "shape":"longString", - "documentation":"The expression to evaluate.
" - } - }, - "documentation":"The input for the EvaluateExpression action.
" - }, - "EvaluateExpressionOutput":{ - "type":"structure", - "required":["evaluatedExpression"], - "members":{ - "evaluatedExpression":{ - "shape":"longString", - "documentation":"The evaluated expression.
" - } - }, - "documentation":"Contains the output from the EvaluateExpression action.
" - }, - "Field":{ - "type":"structure", - "required":["key"], - "members":{ - "key":{ - "shape":"fieldNameString", - "documentation":"The field identifier.
" - }, - "stringValue":{ - "shape":"fieldStringValue", - "documentation":"The field value, expressed as a String.
" - }, - "refValue":{ - "shape":"fieldNameString", - "documentation":"The field value, expressed as the identifier of another object.
" - } - }, - "documentation":"A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.
The identifier of the pipeline.
" - }, - "version":{ - "shape":"string", - "documentation":"The version of the pipeline definition to retrieve. This parameter accepts the values latest (default) and active. Where latest indicates the last definition saved to the pipeline and active indicates the last definition of the pipeline that was activated.
The input for the GetPipelineDefinition action.
" - }, - "GetPipelineDefinitionOutput":{ - "type":"structure", - "members":{ - "pipelineObjects":{ - "shape":"PipelineObjectList", - "documentation":"An array of objects defined in the pipeline.
" - }, - "parameterObjects":{ - "shape":"ParameterObjectList", - "documentation":"Returns a list of parameter objects used in the pipeline definition.
" - }, - "parameterValues":{ - "shape":"ParameterValueList", - "documentation":"Returns a list of parameter values used in the pipeline definition.
" - } - }, - "documentation":"Contains the output from the GetPipelineDefinition action.
" - }, - "InstanceIdentity":{ - "type":"structure", - "members":{ - "document":{ - "shape":"string", - "documentation":"A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.
" - }, - "signature":{ - "shape":"string", - "documentation":"A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.
" - } - }, - "documentation":"Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.
" - }, - "InternalServiceError":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"Description of the error message.
" - } - }, - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"Description of the error message.
" - } - }, - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - "ListPipelinesInput":{ - "type":"structure", - "members":{ - "marker":{ - "shape":"string", - "documentation":"The starting point for the results to be returned. The first time you call ListPipelines, this value should be empty. As long as the action returns HasMoreResults as True, you can call ListPipelines again and pass the marker value from the response to retrieve the next set of results.
The input to the ListPipelines action.
" - }, - "ListPipelinesOutput":{ - "type":"structure", - "required":["pipelineIdList"], - "members":{ - "pipelineIdList":{ - "shape":"pipelineList", - "documentation":"A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
" - }, - "marker":{ - "shape":"string", - "documentation":"If not null, indicates the starting point for the set of pipeline identifiers that the next call to ListPipelines will retrieve. If null, there are no more pipeline identifiers.
" - }, - "hasMoreResults":{ - "shape":"boolean", - "documentation":"If True, there are more results that can be obtained by a subsequent call to ListPipelines.
Contains the output from the ListPipelines action.
" - }, - "Operator":{ - "type":"structure", - "members":{ - "type":{ - "shape":"OperatorType", - "documentation":" The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.
The comparison operators EQ and REF_EQ act on the following fields:
The comparison operators GE, LE, and BETWEEN act on the following fields:
Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".
" - }, - "values":{ - "shape":"stringList", - "documentation":"The value that the actual field value will be compared with.
" - } - }, - "documentation":"Contains a logical operation for comparing the value of a field with a specified value.
" - }, - "OperatorType":{ - "type":"string", - "enum":[ - "EQ", - "REF_EQ", - "LE", - "GE", - "BETWEEN" - ] - }, - "ParameterAttribute":{ - "type":"structure", - "required":[ - "key", - "stringValue" - ], - "members":{ - "key":{ - "shape":"attributeNameString", - "documentation":"The field identifier.
" - }, - "stringValue":{ - "shape":"attributeValueString", - "documentation":"The field value, expressed as a String.
" - } - }, - "documentation":"The attributes allowed or specified with a parameter object.
" - }, - "ParameterAttributeList":{ - "type":"list", - "member":{"shape":"ParameterAttribute"} - }, - "ParameterObject":{ - "type":"structure", - "required":[ - "id", - "attributes" - ], - "members":{ - "id":{ - "shape":"fieldNameString", - "documentation":"Identifier of the parameter object.
" - }, - "attributes":{ - "shape":"ParameterAttributeList", - "documentation":"The attributes of the parameter object.
" - } - }, - "documentation":"Contains information about a parameter object.
" - }, - "ParameterObjectList":{ - "type":"list", - "member":{"shape":"ParameterObject"} - }, - "ParameterValue":{ - "type":"structure", - "required":[ - "id", - "stringValue" - ], - "members":{ - "id":{ - "shape":"fieldNameString", - "documentation":"Identifier of the parameter value.
" - }, - "stringValue":{ - "shape":"fieldStringValue", - "documentation":"The field value, expressed as a String.
" - } - }, - "documentation":"A value or list of parameter values.
" - }, - "ParameterValueList":{ - "type":"list", - "member":{"shape":"ParameterValue"} - }, - "PipelineDeletedException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"Description of the error message.
" - } - }, - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - "PipelineDescription":{ - "type":"structure", - "required":[ - "pipelineId", - "name", - "fields" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
Name of the pipeline.
" - }, - "fields":{ - "shape":"fieldList", - "documentation":"A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
" - }, - "description":{ - "shape":"string", - "documentation":"Description of the pipeline.
" - } - }, - "documentation":"Contains pipeline metadata.
" - }, - "PipelineDescriptionList":{ - "type":"list", - "member":{"shape":"PipelineDescription"} - }, - "PipelineIdName":{ - "type":"structure", - "members":{ - "id":{ - "shape":"id", - "documentation":"Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
Name of the pipeline.
" - } - }, - "documentation":"Contains the name and identifier of a pipeline.
" - }, - "PipelineNotFoundException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"Description of the error message.
" - } - }, - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - "PipelineObject":{ - "type":"structure", - "required":[ - "id", - "name", - "fields" - ], - "members":{ - "id":{ - "shape":"id", - "documentation":"Identifier of the object.
" - }, - "name":{ - "shape":"id", - "documentation":"Name of the object.
" - }, - "fields":{ - "shape":"fieldList", - "documentation":"Key-value pairs that define the properties of the object.
" - } - }, - "documentation":"Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.
" - }, - "PipelineObjectList":{ - "type":"list", - "member":{"shape":"PipelineObject"} - }, - "PipelineObjectMap":{ - "type":"map", - "key":{"shape":"id"}, - "value":{"shape":"PipelineObject"} - }, - "PollForTaskInput":{ - "type":"structure", - "required":["workerGroup"], - "members":{ - "workerGroup":{ - "shape":"string", - "documentation":"Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.
The public DNS name of the calling task runner.
" - }, - "instanceIdentity":{ - "shape":"InstanceIdentity", - "documentation":"Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, http://169.254.169.254/latest/meta-data/instance-id, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.
The data type passed in as input to the PollForTask action.
" - }, - "PollForTaskOutput":{ - "type":"structure", - "members":{ - "taskObject":{ - "shape":"TaskObject", - "documentation":"An instance of TaskObject. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.
" - } - }, - "documentation":"Contains the output from the PollForTask action.
" - }, - "PutPipelineDefinitionInput":{ - "type":"structure", - "required":[ - "pipelineId", - "pipelineObjects" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"The identifier of the pipeline to be configured.
" - }, - "pipelineObjects":{ - "shape":"PipelineObjectList", - "documentation":"The objects that define the pipeline. These will overwrite the existing pipeline definition.
" - }, - "parameterObjects":{ - "shape":"ParameterObjectList", - "documentation":"A list of parameter objects used with the pipeline.
" - }, - "parameterValues":{ - "shape":"ParameterValueList", - "documentation":"A list of parameter values used with the pipeline.
" - } - }, - "documentation":"The input of the PutPipelineDefinition action.
" - }, - "PutPipelineDefinitionOutput":{ - "type":"structure", - "required":["errored"], - "members":{ - "validationErrors":{ - "shape":"ValidationErrors", - "documentation":"A list of the validation errors that are associated with the objects defined in pipelineObjects.
A list of the validation warnings that are associated with the objects defined in pipelineObjects.
If True, there were validation errors. If errored is True, the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.
Contains the output of the PutPipelineDefinition action.
" - }, - "Query":{ - "type":"structure", - "members":{ - "selectors":{ - "shape":"SelectorList", - "documentation":"List of selectors that define the query. An object must satisfy all of the selectors to match the query.
" - } - }, - "documentation":"Defines the query to run against an object.
" - }, - "QueryObjectsInput":{ - "type":"structure", - "required":[ - "pipelineId", - "sphere" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"Identifier of the pipeline to be queried for object names.
" - }, - "query":{ - "shape":"Query", - "documentation":"Query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.
" - }, - "sphere":{ - "shape":"string", - "documentation":" Specifies whether the query applies to components or instances. Allowable values: COMPONENT, INSTANCE, ATTEMPT.
The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.
Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.
" - } - }, - "documentation":"The input for the QueryObjects action.
" - }, - "QueryObjectsOutput":{ - "type":"structure", - "members":{ - "ids":{ - "shape":"idList", - "documentation":"A list of identifiers that match the query selectors.
" - }, - "marker":{ - "shape":"string", - "documentation":" The starting point for the results to be returned. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.
If True, there are more results that can be obtained by a subsequent call to QueryObjects.
Contains the output from the QueryObjects action.
" - }, - "ReportTaskProgressInput":{ - "type":"structure", - "required":["taskId"], - "members":{ - "taskId":{ - "shape":"taskId", - "documentation":"Identifier of the task assigned to the task runner. This value is provided in the TaskObject that the service returns with the response for the PollForTask action.
" - }, - "fields":{ - "shape":"fieldList", - "documentation":"Key-value pairs that define the properties of the ReportTaskProgressInput object.
" - } - }, - "documentation":"The input for the ReportTaskProgress action.
" - }, - "ReportTaskProgressOutput":{ - "type":"structure", - "required":["canceled"], - "members":{ - "canceled":{ - "shape":"boolean", - "documentation":"If True, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.
Contains the output from the ReportTaskProgress action.
" - }, - "ReportTaskRunnerHeartbeatInput":{ - "type":"structure", - "required":["taskrunnerId"], - "members":{ - "taskrunnerId":{ - "shape":"id", - "documentation":"The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.
" - }, - "workerGroup":{ - "shape":"string", - "documentation":"Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to ReportTaskRunnerHeartbeat. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.
The public DNS name of the calling task runner.
" - } - }, - "documentation":"The input for the ReportTaskRunnerHeartbeat action.
" - }, - "ReportTaskRunnerHeartbeatOutput":{ - "type":"structure", - "required":["terminate"], - "members":{ - "terminate":{ - "shape":"boolean", - "documentation":"Indicates whether the calling task runner should terminate. If True, the task runner that called ReportTaskRunnerHeartbeat should terminate.
Contains the output from the ReportTaskRunnerHeartbeat action.
" - }, - "Selector":{ - "type":"structure", - "members":{ - "fieldName":{ - "shape":"string", - "documentation":"The name of the field that the operator will be applied to. The field name is the \"key\" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.
" - }, - "operator":{"shape":"Operator"} - }, - "documentation":"A comparision that is used to determine whether a query should return this object.
" - }, - "SelectorList":{ - "type":"list", - "member":{"shape":"Selector"}, - "documentation":"The list of Selectors that define queries on individual fields.
" - }, - "SetStatusInput":{ - "type":"structure", - "required":[ - "pipelineId", - "objectIds", - "status" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"Identifies the pipeline that contains the objects.
" - }, - "objectIds":{ - "shape":"idList", - "documentation":"Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.
" - }, - "status":{ - "shape":"string", - "documentation":"Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.
The input to the SetStatus action.
" - }, - "SetTaskStatusInput":{ - "type":"structure", - "required":[ - "taskId", - "taskStatus" - ], - "members":{ - "taskId":{ - "shape":"taskId", - "documentation":"Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.
" - }, - "taskStatus":{ - "shape":"TaskStatus", - "documentation":"If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.
If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.
" - }, - "errorMessage":{ - "shape":"errorMessage", - "documentation":"If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
" - }, - "errorStackTrace":{ - "shape":"string", - "documentation":"If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
" - } - }, - "documentation":"The input of the SetTaskStatus action.
" - }, - "SetTaskStatusOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output from the SetTaskStatus action.
" - }, - "TaskNotFoundException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"Description of the error message.
" - } - }, - "exception":true, - "documentation":"The specified task was not found.
" - }, - "TaskObject":{ - "type":"structure", - "members":{ - "taskId":{ - "shape":"taskId", - "documentation":"An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
" - }, - "pipelineId":{ - "shape":"id", - "documentation":"Identifier of the pipeline that provided the task.
" - }, - "attemptId":{ - "shape":"id", - "documentation":"Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.
" - }, - "objects":{ - "shape":"PipelineObjectMap", - "documentation":"Connection information for the location where the task runner will publish the output of the task.
" - } - }, - "documentation":"Contains information about a pipeline task that is assigned to a task runner.
" - }, - "TaskStatus":{ - "type":"string", - "enum":[ - "FINISHED", - "FAILED", - "FALSE" - ] - }, - "ValidatePipelineDefinitionInput":{ - "type":"structure", - "required":[ - "pipelineId", - "pipelineObjects" - ], - "members":{ - "pipelineId":{ - "shape":"id", - "documentation":"Identifies the pipeline whose definition is to be validated.
" - }, - "pipelineObjects":{ - "shape":"PipelineObjectList", - "documentation":"A list of objects that define the pipeline changes to validate against the pipeline.
" - }, - "parameterObjects":{ - "shape":"ParameterObjectList", - "documentation":"A list of parameter objects used with the pipeline.
" - }, - "parameterValues":{ - "shape":"ParameterValueList", - "documentation":"A list of parameter values used with the pipeline.
" - } - }, - "documentation":"The input of the ValidatePipelineDefinition action.
" - }, - "ValidatePipelineDefinitionOutput":{ - "type":"structure", - "required":["errored"], - "members":{ - "validationErrors":{ - "shape":"ValidationErrors", - "documentation":"Lists the validation errors that were found by ValidatePipelineDefinition.
" - }, - "validationWarnings":{ - "shape":"ValidationWarnings", - "documentation":"Lists the validation warnings that were found by ValidatePipelineDefinition.
" - }, - "errored":{ - "shape":"boolean", - "documentation":"If True, there were validation errors.
Contains the output from the ValidatePipelineDefinition action.
" - }, - "ValidationError":{ - "type":"structure", - "members":{ - "id":{ - "shape":"id", - "documentation":"The identifier of the object that contains the validation error.
" - }, - "errors":{ - "shape":"validationMessages", - "documentation":"A description of the validation error.
" - } - }, - "documentation":"Defines a validation error returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.
" - }, - "ValidationErrors":{ - "type":"list", - "member":{"shape":"ValidationError"} - }, - "ValidationWarning":{ - "type":"structure", - "members":{ - "id":{ - "shape":"id", - "documentation":"The identifier of the object that contains the validation warning.
" - }, - "warnings":{ - "shape":"validationMessages", - "documentation":"A description of the validation warning.
" - } - }, - "documentation":"Defines a validation warning returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.
" - }, - "ValidationWarnings":{ - "type":"list", - "member":{"shape":"ValidationWarning"} - }, - "attributeNameString":{ - "type":"string", - "min":1, - "max":256, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "attributeValueString":{ - "type":"string", - "min":0, - "max":10240, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "boolean":{"type":"boolean"}, - "errorMessage":{"type":"string"}, - "fieldList":{ - "type":"list", - "member":{"shape":"Field"} - }, - "fieldNameString":{ - "type":"string", - "min":1, - "max":256, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "fieldStringValue":{ - "type":"string", - "min":0, - "max":10240, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "id":{ - "type":"string", - "min":1, - "max":1024, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "idList":{ - "type":"list", - "member":{"shape":"id"} - }, - "int":{"type":"integer"}, - "longString":{ - "type":"string", - "min":0, - "max":20971520, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "pipelineList":{ - "type":"list", - "member":{"shape":"PipelineIdName"} - }, - "string":{ - "type":"string", - "min":0, - "max":1024, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "stringList":{ - "type":"list", - "member":{"shape":"string"} - }, - "taskId":{ - "type":"string", - "min":1, - "max":2048, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "validationMessage":{ - "type":"string", - "min":0, - "max":10000, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "validationMessages":{ - "type":"list", - "member":{"shape":"validationMessage"} - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/datapipeline/2012-10-29.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/datapipeline/2012-10-29.paginators.json deleted file mode 100644 index c859c9fbfb..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/datapipeline/2012-10-29.paginators.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "pagination": { - "ListPipelines": { - "input_token": "marker", - "output_token": "marker", - "more_results": "hasMoreResults", - "result_key": "pipelineIdList" - }, - "DescribeObjects": { - "input_token": "marker", - "output_token": "marker", - "more_results": "hasMoreResults", - "result_key": "pipelineObjects" - }, - "QueryObjects": { - "input_token": "marker", - "output_token": "marker", - "more_results": "hasMoreResults", - "limit_key": "limit", - "result_key": "ids" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/directconnect/2012-10-25.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/directconnect/2012-10-25.normal.json deleted file mode 100644 index a8f0603112..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/directconnect/2012-10-25.normal.json +++ /dev/null @@ -1,1174 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-10-25", - "endpointPrefix":"directconnect", - "jsonVersion":"1.1", - "serviceFullName":"AWS Direct Connect", - "signatureVersion":"v4", - "targetPrefix":"OvertureService", - "protocol":"json" - }, - "documentation":"AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.
The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference:
Container for the parameters to the AllocateConnectionOnInterconnect operation.
" - }, - "output":{ - "shape":"Connection", - "documentation":"A connection represents the physical network connection between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Creates a hosted connection on an interconnect.
Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.
" - }, - "AllocatePrivateVirtualInterface":{ - "name":"AllocatePrivateVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AllocatePrivateVirtualInterfaceRequest", - "documentation":"Container for the parameters to the AllocatePrivateVirtualInterface operation.
" - }, - "output":{ - "shape":"VirtualInterface", - "documentation":"A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Provisions a private virtual interface to be owned by a different customer.
The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.
Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
" - }, - "AllocatePublicVirtualInterface":{ - "name":"AllocatePublicVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AllocatePublicVirtualInterfaceRequest", - "documentation":"Container for the parameters to the AllocatePublicVirtualInterface operation.
" - }, - "output":{ - "shape":"VirtualInterface", - "documentation":"A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Provisions a public virtual interface to be owned by a different customer.
The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.
Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
" - }, - "ConfirmConnection":{ - "name":"ConfirmConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ConfirmConnectionRequest", - "documentation":"Container for the parameters to the ConfirmConnection operation.
" - }, - "output":{ - "shape":"ConfirmConnectionResponse", - "documentation":"The response received when ConfirmConnection is called.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Confirm the creation of a hosted connection on an interconnect.
Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.
" - }, - "ConfirmPrivateVirtualInterface":{ - "name":"ConfirmPrivateVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ConfirmPrivateVirtualInterfaceRequest", - "documentation":"Container for the parameters to the ConfirmPrivateVirtualInterface operation.
" - }, - "output":{ - "shape":"ConfirmPrivateVirtualInterfaceResponse", - "documentation":"The response received when ConfirmPrivateVirtualInterface is called.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Accept ownership of a private virtual interface created by another customer.
After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.
" - }, - "ConfirmPublicVirtualInterface":{ - "name":"ConfirmPublicVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ConfirmPublicVirtualInterfaceRequest", - "documentation":"Container for the parameters to the ConfirmPublicVirtualInterface operation.
" - }, - "output":{ - "shape":"ConfirmPublicVirtualInterfaceResponse", - "documentation":"The response received when ConfirmPublicVirtualInterface is called.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Accept ownership of a public virtual interface created by another customer.
After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.
" - }, - "CreateConnection":{ - "name":"CreateConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateConnectionRequest", - "documentation":"Container for the parameters to the CreateConnection operation.
" - }, - "output":{ - "shape":"Connection", - "documentation":"A connection represents the physical network connection between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Creates a new connection between the customer network and a specific AWS Direct Connect location.
A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.
" - }, - "CreateInterconnect":{ - "name":"CreateInterconnect", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateInterconnectRequest", - "documentation":"Container for the parameters to the CreateInterconnect operation.
" - }, - "output":{ - "shape":"Interconnect", - "documentation":"An interconnect is a connection that can host other connections.
Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.
The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.
An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.
For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.
" - }, - "CreatePrivateVirtualInterface":{ - "name":"CreatePrivateVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreatePrivateVirtualInterfaceRequest", - "documentation":"Container for the parameters to the CreatePrivateVirtualInterface operation.
" - }, - "output":{ - "shape":"VirtualInterface", - "documentation":"A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).
" - }, - "CreatePublicVirtualInterface":{ - "name":"CreatePublicVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreatePublicVirtualInterfaceRequest", - "documentation":"Container for the parameters to the CreatePublicVirtualInterface operation.
" - }, - "output":{ - "shape":"VirtualInterface", - "documentation":"A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).
" - }, - "DeleteConnection":{ - "name":"DeleteConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteConnectionRequest", - "documentation":"Container for the parameters to the DeleteConnection operation.
" - }, - "output":{ - "shape":"Connection", - "documentation":"A connection represents the physical network connection between the AWS Direct Connect location and the customer.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Deletes the connection.
Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.
" - }, - "DeleteInterconnect":{ - "name":"DeleteInterconnect", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteInterconnectRequest", - "documentation":"Container for the parameters to the DeleteInterconnect operation.
" - }, - "output":{ - "shape":"DeleteInterconnectResponse", - "documentation":"The response received when DeleteInterconnect is called.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Deletes the specified interconnect.
" - }, - "DeleteVirtualInterface":{ - "name":"DeleteVirtualInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteVirtualInterfaceRequest", - "documentation":"Container for the parameters to the DeleteVirtualInterface operation.
" - }, - "output":{ - "shape":"DeleteVirtualInterfaceResponse", - "documentation":"The response received when DeleteVirtualInterface is called.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Deletes a virtual interface.
" - }, - "DescribeConnections":{ - "name":"DescribeConnections", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeConnectionsRequest", - "documentation":"Container for the parameters to the DescribeConnections operation.
" - }, - "output":{ - "shape":"Connections", - "documentation":"A structure containing a list of connections.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Displays all connections in this region.
If a connection ID is provided, the call returns only that particular connection.
" - }, - "DescribeConnectionsOnInterconnect":{ - "name":"DescribeConnectionsOnInterconnect", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeConnectionsOnInterconnectRequest", - "documentation":"Container for the parameters to the DescribeConnectionsOnInterconnect operation.
" - }, - "output":{ - "shape":"Connections", - "documentation":"A structure containing a list of connections.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Return a list of connections that have been provisioned on the given interconnect.
" - }, - "DescribeInterconnects":{ - "name":"DescribeInterconnects", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeInterconnectsRequest", - "documentation":"Container for the parameters to the DescribeInterconnects operation.
" - }, - "output":{ - "shape":"Interconnects", - "documentation":"A structure containing a list of interconnects.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Returns a list of interconnects owned by the AWS account.
If an interconnect ID is provided, it will only return this particular interconnect.
" - }, - "DescribeLocations":{ - "name":"DescribeLocations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{"shape":"Locations"}, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.
" - }, - "DescribeVirtualGateways":{ - "name":"DescribeVirtualGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"VirtualGateways", - "documentation":"A structure containing a list of virtual private gateways.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Returns a list of virtual private gateways owned by the AWS account.
You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
" - }, - "DescribeVirtualInterfaces":{ - "name":"DescribeVirtualInterfaces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeVirtualInterfacesRequest", - "documentation":"Container for the parameters to the DescribeVirtualInterfaces operation.
" - }, - "output":{ - "shape":"VirtualInterfaces", - "documentation":"A structure containing a list of virtual interfaces.
" - }, - "errors":[ - { - "shape":"DirectConnectServerException", - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - { - "shape":"DirectConnectClientException", - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - } - ], - "documentation":"Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.
" - } - }, - "shapes":{ - "ASN":{ - "type":"integer", - "documentation":"Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
" - }, - "AllocateConnectionOnInterconnectRequest":{ - "type":"structure", - "required":[ - "bandwidth", - "connectionName", - "ownerAccount", - "interconnectId", - "vlan" - ], - "members":{ - "bandwidth":{ - "shape":"Bandwidth", - "documentation":"Bandwidth of the connection.
Example: \"500Mbps\"
Default: None
" - }, - "connectionName":{ - "shape":"ConnectionName", - "documentation":"Name of the provisioned connection.
Example: \"500M Connection to AWS\"
Default: None
" - }, - "ownerAccount":{ - "shape":"OwnerAccount", - "documentation":"Numeric account Id of the customer for whom the connection will be provisioned.
Example: 123443215678
Default: None
" - }, - "interconnectId":{ - "shape":"InterconnectId", - "documentation":"ID of the interconnect on which the connection will be provisioned.
Example: dxcon-456abc78
Default: None
" - }, - "vlan":{ - "shape":"VLAN", - "documentation":"The dedicated VLAN provisioned to the connection.
Example: 101
Default: None
" - } - }, - "documentation":"Container for the parameters to the AllocateConnectionOnInterconnect operation.
" - }, - "AllocatePrivateVirtualInterfaceRequest":{ - "type":"structure", - "required":[ - "connectionId", - "ownerAccount", - "newPrivateVirtualInterfaceAllocation" - ], - "members":{ - "connectionId":{ - "shape":"ConnectionId", - "documentation":"The connection ID on which the private virtual interface is provisioned.
Default: None
" - }, - "ownerAccount":{ - "shape":"OwnerAccount", - "documentation":"The AWS account that will own the new private virtual interface.
Default: None
" - }, - "newPrivateVirtualInterfaceAllocation":{ - "shape":"NewPrivateVirtualInterfaceAllocation", - "documentation":"Detailed information for the private virtual interface to be provisioned.
Default: None
" - } - }, - "documentation":"Container for the parameters to the AllocatePrivateVirtualInterface operation.
" - }, - "AllocatePublicVirtualInterfaceRequest":{ - "type":"structure", - "required":[ - "connectionId", - "ownerAccount", - "newPublicVirtualInterfaceAllocation" - ], - "members":{ - "connectionId":{ - "shape":"ConnectionId", - "documentation":"The connection ID on which the public virtual interface is provisioned.
Default: None
" - }, - "ownerAccount":{ - "shape":"OwnerAccount", - "documentation":"The AWS account that will own the new public virtual interface.
Default: None
" - }, - "newPublicVirtualInterfaceAllocation":{ - "shape":"NewPublicVirtualInterfaceAllocation", - "documentation":"Detailed information for the public virtual interface to be provisioned.
Default: None
" - } - }, - "documentation":"Container for the parameters to the AllocatePublicVirtualInterface operation.
" - }, - "AmazonAddress":{ - "type":"string", - "documentation":"IP address assigned to the Amazon interface.
Example: 192.168.1.1/30
" - }, - "BGPAuthKey":{ - "type":"string", - "documentation":"Authentication key for BGP configuration.
Example: asdf34example
" - }, - "Bandwidth":{ - "type":"string", - "documentation":"Bandwidth of the connection.
Example: 1Gbps
Default: None
" - }, - "CIDR":{"type":"string"}, - "ConfirmConnectionRequest":{ - "type":"structure", - "required":["connectionId"], - "members":{ - "connectionId":{"shape":"ConnectionId"} - }, - "documentation":"Container for the parameters to the ConfirmConnection operation.
" - }, - "ConfirmConnectionResponse":{ - "type":"structure", - "members":{ - "connectionState":{"shape":"ConnectionState"} - }, - "documentation":"The response received when ConfirmConnection is called.
" - }, - "ConfirmPrivateVirtualInterfaceRequest":{ - "type":"structure", - "required":[ - "virtualInterfaceId", - "virtualGatewayId" - ], - "members":{ - "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, - "virtualGatewayId":{ - "shape":"VirtualGatewayId", - "documentation":"ID of the virtual private gateway that will be attached to the virtual interface.
A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Default: None
" - } - }, - "documentation":"Container for the parameters to the ConfirmPrivateVirtualInterface operation.
" - }, - "ConfirmPrivateVirtualInterfaceResponse":{ - "type":"structure", - "members":{ - "virtualInterfaceState":{"shape":"VirtualInterfaceState"} - }, - "documentation":"The response received when ConfirmPrivateVirtualInterface is called.
" - }, - "ConfirmPublicVirtualInterfaceRequest":{ - "type":"structure", - "required":["virtualInterfaceId"], - "members":{ - "virtualInterfaceId":{"shape":"VirtualInterfaceId"} - }, - "documentation":"Container for the parameters to the ConfirmPublicVirtualInterface operation.
" - }, - "ConfirmPublicVirtualInterfaceResponse":{ - "type":"structure", - "members":{ - "virtualInterfaceState":{"shape":"VirtualInterfaceState"} - }, - "documentation":"The response received when ConfirmPublicVirtualInterface is called.
" - }, - "Connection":{ - "type":"structure", - "members":{ - "ownerAccount":{"shape":"OwnerAccount"}, - "connectionId":{"shape":"ConnectionId"}, - "connectionName":{"shape":"ConnectionName"}, - "connectionState":{"shape":"ConnectionState"}, - "region":{"shape":"Region"}, - "location":{"shape":"LocationCode"}, - "bandwidth":{ - "shape":"Bandwidth", - "documentation":"Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
" - }, - "vlan":{"shape":"VLAN"}, - "partnerName":{"shape":"PartnerName"} - }, - "documentation":"A connection represents the physical network connection between the AWS Direct Connect location and the customer.
" - }, - "ConnectionId":{ - "type":"string", - "documentation":"ID of the connection.
Example: dxcon-fg5678gh
Default: None
" - }, - "ConnectionList":{ - "type":"list", - "member":{"shape":"Connection"}, - "documentation":"A list of connections.
" - }, - "ConnectionName":{ - "type":"string", - "documentation":"The name of the connection.
Example: \"My Connection to AWS\"
Default: None
" - }, - "ConnectionState":{ - "type":"string", - "enum":[ - "ordering", - "requested", - "pending", - "available", - "down", - "deleting", - "deleted", - "rejected" - ], - "documentation":"State of the connection.A list of connections.
" - } - }, - "documentation":"A structure containing a list of connections.
" - }, - "CreateConnectionRequest":{ - "type":"structure", - "required":[ - "location", - "bandwidth", - "connectionName" - ], - "members":{ - "location":{"shape":"LocationCode"}, - "bandwidth":{"shape":"Bandwidth"}, - "connectionName":{"shape":"ConnectionName"} - }, - "documentation":"Container for the parameters to the CreateConnection operation.
" - }, - "CreateInterconnectRequest":{ - "type":"structure", - "required":[ - "interconnectName", - "bandwidth", - "location" - ], - "members":{ - "interconnectName":{ - "shape":"InterconnectName", - "documentation":"The name of the interconnect.
Example: \"1G Interconnect to AWS\"
Default: None
" - }, - "bandwidth":{ - "shape":"Bandwidth", - "documentation":"The port bandwidth
Example: 1Gbps
Default: None
Available values: 1Gbps,10Gbps
" - }, - "location":{ - "shape":"LocationCode", - "documentation":"Where the interconnect is located
Example: EqSV5
Default: None
" - } - }, - "documentation":"Container for the parameters to the CreateInterconnect operation.
" - }, - "CreatePrivateVirtualInterfaceRequest":{ - "type":"structure", - "required":[ - "connectionId", - "newPrivateVirtualInterface" - ], - "members":{ - "connectionId":{"shape":"ConnectionId"}, - "newPrivateVirtualInterface":{ - "shape":"NewPrivateVirtualInterface", - "documentation":"Detailed information for the private virtual interface to be created.
Default: None
" - } - }, - "documentation":"Container for the parameters to the CreatePrivateVirtualInterface operation.
" - }, - "CreatePublicVirtualInterfaceRequest":{ - "type":"structure", - "required":[ - "connectionId", - "newPublicVirtualInterface" - ], - "members":{ - "connectionId":{"shape":"ConnectionId"}, - "newPublicVirtualInterface":{ - "shape":"NewPublicVirtualInterface", - "documentation":"Detailed information for the public virtual interface to be created.
Default: None
" - } - }, - "documentation":"Container for the parameters to the CreatePublicVirtualInterface operation.
" - }, - "CustomerAddress":{ - "type":"string", - "documentation":"IP address assigned to the customer interface.
Example: 192.168.1.2/30
" - }, - "DeleteConnectionRequest":{ - "type":"structure", - "required":["connectionId"], - "members":{ - "connectionId":{"shape":"ConnectionId"} - }, - "documentation":"Container for the parameters to the DeleteConnection operation.
" - }, - "DeleteInterconnectRequest":{ - "type":"structure", - "required":["interconnectId"], - "members":{ - "interconnectId":{"shape":"InterconnectId"} - }, - "documentation":"Container for the parameters to the DeleteInterconnect operation.
" - }, - "DeleteInterconnectResponse":{ - "type":"structure", - "members":{ - "interconnectState":{"shape":"InterconnectState"} - }, - "documentation":"The response received when DeleteInterconnect is called.
" - }, - "DeleteVirtualInterfaceRequest":{ - "type":"structure", - "required":["virtualInterfaceId"], - "members":{ - "virtualInterfaceId":{"shape":"VirtualInterfaceId"} - }, - "documentation":"Container for the parameters to the DeleteVirtualInterface operation.
" - }, - "DeleteVirtualInterfaceResponse":{ - "type":"structure", - "members":{ - "virtualInterfaceState":{"shape":"VirtualInterfaceState"} - }, - "documentation":"The response received when DeleteVirtualInterface is called.
" - }, - "DescribeConnectionsOnInterconnectRequest":{ - "type":"structure", - "required":["interconnectId"], - "members":{ - "interconnectId":{ - "shape":"InterconnectId", - "documentation":"ID of the interconnect on which a list of connection is provisioned.
Example: dxcon-abc123
Default: None
" - } - }, - "documentation":"Container for the parameters to the DescribeConnectionsOnInterconnect operation.
" - }, - "DescribeConnectionsRequest":{ - "type":"structure", - "members":{ - "connectionId":{"shape":"ConnectionId"} - }, - "documentation":"Container for the parameters to the DescribeConnections operation.
" - }, - "DescribeInterconnectsRequest":{ - "type":"structure", - "members":{ - "interconnectId":{"shape":"InterconnectId"} - }, - "documentation":"Container for the parameters to the DescribeInterconnects operation.
" - }, - "DescribeVirtualInterfacesRequest":{ - "type":"structure", - "members":{ - "connectionId":{"shape":"ConnectionId"}, - "virtualInterfaceId":{"shape":"VirtualInterfaceId"} - }, - "documentation":"Container for the parameters to the DescribeVirtualInterfaces operation.
" - }, - "DirectConnectClientException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "exception":true, - "documentation":"The API was called with invalid parameters. The error message will contain additional details about the cause.
" - }, - "DirectConnectServerException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "exception":true, - "documentation":"A server-side error occurred during the API call. The error message will contain additional details about the cause.
" - }, - "ErrorMessage":{"type":"string"}, - "Interconnect":{ - "type":"structure", - "members":{ - "interconnectId":{"shape":"InterconnectId"}, - "interconnectName":{"shape":"InterconnectName"}, - "interconnectState":{"shape":"InterconnectState"}, - "region":{"shape":"Region"}, - "location":{"shape":"LocationCode"}, - "bandwidth":{"shape":"Bandwidth"} - }, - "documentation":"An interconnect is a connection that can host other connections.
Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.
The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.
" - }, - "InterconnectId":{ - "type":"string", - "documentation":"The ID of the interconnect.
Example: dxcon-abc123
" - }, - "InterconnectList":{ - "type":"list", - "member":{"shape":"Interconnect"}, - "documentation":"A list of interconnects.
" - }, - "InterconnectName":{ - "type":"string", - "documentation":"The name of the interconnect.
Example: \"1G Interconnect to AWS\"
" - }, - "InterconnectState":{ - "type":"string", - "enum":[ - "requested", - "pending", - "available", - "down", - "deleting", - "deleted" - ], - "documentation":"State of the interconnect.A list of interconnects.
" - } - }, - "documentation":"A structure containing a list of interconnects.
" - }, - "Location":{ - "type":"structure", - "members":{ - "locationCode":{ - "shape":"LocationCode", - "documentation":"The code used to indicate the AWS Direct Connect location.
" - }, - "locationName":{ - "shape":"LocationName", - "documentation":"The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.
" - } - }, - "documentation":"An AWS Direct Connect location where connections and interconnects can be requested.
" - }, - "LocationCode":{ - "type":"string", - "documentation":"Where the connection is located.
Example: EqSV5
Default: None
" - }, - "LocationList":{ - "type":"list", - "member":{"shape":"Location"} - }, - "LocationName":{"type":"string"}, - "Locations":{ - "type":"structure", - "members":{ - "locations":{"shape":"LocationList"} - } - }, - "NewPrivateVirtualInterface":{ - "type":"structure", - "required":[ - "virtualInterfaceName", - "vlan", - "asn", - "virtualGatewayId" - ], - "members":{ - "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, - "vlan":{"shape":"VLAN"}, - "asn":{"shape":"ASN"}, - "authKey":{"shape":"BGPAuthKey"}, - "amazonAddress":{"shape":"AmazonAddress"}, - "customerAddress":{"shape":"CustomerAddress"}, - "virtualGatewayId":{"shape":"VirtualGatewayId"} - }, - "documentation":"A structure containing information about a new private virtual interface.
" - }, - "NewPrivateVirtualInterfaceAllocation":{ - "type":"structure", - "required":[ - "virtualInterfaceName", - "vlan", - "asn" - ], - "members":{ - "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, - "vlan":{"shape":"VLAN"}, - "asn":{"shape":"ASN"}, - "authKey":{"shape":"BGPAuthKey"}, - "amazonAddress":{"shape":"AmazonAddress"}, - "customerAddress":{"shape":"CustomerAddress"} - }, - "documentation":"A structure containing information about a private virtual interface that will be provisioned on a connection.
" - }, - "NewPublicVirtualInterface":{ - "type":"structure", - "required":[ - "virtualInterfaceName", - "vlan", - "asn", - "amazonAddress", - "customerAddress", - "routeFilterPrefixes" - ], - "members":{ - "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, - "vlan":{"shape":"VLAN"}, - "asn":{"shape":"ASN"}, - "authKey":{"shape":"BGPAuthKey"}, - "amazonAddress":{"shape":"AmazonAddress"}, - "customerAddress":{"shape":"CustomerAddress"}, - "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} - }, - "documentation":"A structure containing information about a new public virtual interface.
" - }, - "NewPublicVirtualInterfaceAllocation":{ - "type":"structure", - "required":[ - "virtualInterfaceName", - "vlan", - "asn", - "amazonAddress", - "customerAddress", - "routeFilterPrefixes" - ], - "members":{ - "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, - "vlan":{"shape":"VLAN"}, - "asn":{"shape":"ASN"}, - "authKey":{"shape":"BGPAuthKey"}, - "amazonAddress":{"shape":"AmazonAddress"}, - "customerAddress":{"shape":"CustomerAddress"}, - "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} - }, - "documentation":"A structure containing information about a public virtual interface that will be provisioned on a connection.
" - }, - "OwnerAccount":{"type":"string"}, - "PartnerName":{"type":"string"}, - "Region":{ - "type":"string", - "documentation":"The AWS region where the connection is located.
Example: us-east-1
Default: None
" - }, - "RouteFilterPrefix":{ - "type":"structure", - "members":{ - "cidr":{ - "shape":"CIDR", - "documentation":"CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
" - } - }, - "documentation":"A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
" - }, - "RouteFilterPrefixList":{ - "type":"list", - "member":{"shape":"RouteFilterPrefix"}, - "documentation":"A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).
" - }, - "RouterConfig":{"type":"string"}, - "VLAN":{ - "type":"integer", - "documentation":"The VLAN ID.
Example: 101
" - }, - "VirtualGateway":{ - "type":"structure", - "members":{ - "virtualGatewayId":{"shape":"VirtualGatewayId"}, - "virtualGatewayState":{"shape":"VirtualGatewayState"} - }, - "documentation":"You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.
Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the Amazon EC2 CreateVpnGateway action.
" - }, - "VirtualGatewayId":{ - "type":"string", - "documentation":"The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
" - }, - "VirtualGatewayList":{ - "type":"list", - "member":{"shape":"VirtualGateway"}, - "documentation":"A list of virtual private gateways.
" - }, - "VirtualGatewayState":{ - "type":"string", - "documentation":"State of the virtual private gateway.A list of virtual private gateways.
" - } - }, - "documentation":"A structure containing a list of virtual private gateways.
" - }, - "VirtualInterface":{ - "type":"structure", - "members":{ - "ownerAccount":{"shape":"OwnerAccount"}, - "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, - "location":{"shape":"LocationCode"}, - "connectionId":{"shape":"ConnectionId"}, - "virtualInterfaceType":{"shape":"VirtualInterfaceType"}, - "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, - "vlan":{"shape":"VLAN"}, - "asn":{"shape":"ASN"}, - "authKey":{"shape":"BGPAuthKey"}, - "amazonAddress":{"shape":"AmazonAddress"}, - "customerAddress":{"shape":"CustomerAddress"}, - "virtualInterfaceState":{"shape":"VirtualInterfaceState"}, - "customerRouterConfig":{ - "shape":"RouterConfig", - "documentation":"Information for generating the customer router configuration.
" - }, - "virtualGatewayId":{"shape":"VirtualGatewayId"}, - "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} - }, - "documentation":"A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
" - }, - "VirtualInterfaceId":{ - "type":"string", - "documentation":"ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
" - }, - "VirtualInterfaceList":{ - "type":"list", - "member":{"shape":"VirtualInterface"}, - "documentation":"A list of virtual interfaces.
" - }, - "VirtualInterfaceName":{ - "type":"string", - "documentation":"The name of the virtual interface assigned by the customer.
Example: \"My VPC\"
" - }, - "VirtualInterfaceState":{ - "type":"string", - "enum":[ - "confirming", - "verifying", - "pending", - "available", - "deleting", - "deleted", - "rejected" - ], - "documentation":"State of the virtual interface.The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
" - }, - "VirtualInterfaces":{ - "type":"structure", - "members":{ - "virtualInterfaces":{ - "shape":"VirtualInterfaceList", - "documentation":"A list of virtual interfaces.
" - } - }, - "documentation":"A structure containing a list of virtual interfaces.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.normal.json deleted file mode 100644 index 63d87961b2..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.normal.json +++ /dev/null @@ -1,1987 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-08-10", - "endpointPrefix":"dynamodb", - "jsonVersion":"1.0", - "serviceAbbreviation":"DynamoDB", - "serviceFullName":"Amazon DynamoDB", - "signatureVersion":"v4", - "targetPrefix":"DynamoDB_20120810", - "protocol":"json" - }, - "documentation":"This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the low-level DynamoDB API. For information about DynamoDB application development, go to the Amazon DynamoDB Developer Guide.
Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, go to Using the AWS SDKs with DynamoDB in the Amazon DynamoDB Developer Guide.
If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, go to Using the DynamoDB API in the Amazon DynamoDB Developer Guide.
The following are short descriptions of each low-level API action, organized by function.
Managing Tables
CreateTable - Creates a table with user-specified provisioned throughput settings. You must designate one attribute as the hash primary key for the table; you can optionally designate a second attribute as the range primary key. DynamoDB creates indexes on these key attributes for fast data access. Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes.
DescribeTable - Returns metadata for a table, such as table size, status, and index information.
UpdateTable - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table.
ListTables - Returns a list of all tables associated with the current AWS account and endpoint.
DeleteTable - Deletes a table and all of its indexes.
For conceptual information about managing tables, go to Working with Tables in the Amazon DynamoDB Developer Guide.
Reading Data
GetItem - Returns a set of attributes for the item that has a given primary key. By default, GetItem performs an eventually consistent read; however, applications can specify a strongly consistent read instead.
BatchGetItem - Performs multiple GetItem requests for data items using their primary keys, from one table or multiple tables. The response from BatchGetItem has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used.
Query - Returns one or more items from a table or a secondary index. You must provide a specific hash key value. You can narrow the scope of the query using comparison operators against a range key value, or on the index key. Query supports either eventual or strong consistency. A single response has a size limit of 1 MB.
Scan - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. Scan can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, Scan should not be used for any application query use case that requires predictable performance.
For conceptual information about reading data, go to Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.
Modifying Data
PutItem - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist.
UpdateItem - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions.
DeleteItem - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions.
BatchWriteItem - Performs multiple PutItem and DeleteItem requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire BatchWriteItem operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB.
For conceptual information about modifying data, go to Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide.
", - "operations":{ - "BatchGetItem":{ - "name":"BatchGetItem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"BatchGetItemInput", - "documentation":"Represents the input of a BatchGetItem operation.
" - }, - "output":{ - "shape":"BatchGetItemOutput", - "documentation":"Represents the output of a BatchGetItem operation.
" - }, - "errors":[ - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
" - } - ], - "documentation":"The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, go to Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem retrieves items in parallel.
When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.
If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.
" - }, - "BatchWriteItem":{ - "name":"BatchWriteItem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"BatchWriteItemInput", - "documentation":"Represents the input of a BatchWriteItem operation.
" - }, - "output":{ - "shape":"BatchWriteItemOutput", - "documentation":"Represents the output of a BatchWriteItem operation.
" - }, - "errors":[ - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
" - }, - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An error occurred on the server side.
" - } - ], - "documentation":"The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, go to Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, such as Java, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, such as PHP, you must update or delete the specified items one at a time. In both situations, BatchWriteItem provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Represents the input of a CreateTable operation.
" - }, - "output":{ - "shape":"CreateTableOutput", - "documentation":"Represents the output of a CreateTable operation.
" - }, - "errors":[ - { - "shape":"ResourceInUseException", - "exception":true, - "documentation":"The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
An error occurred on the server side.
" - } - ], - "documentation":"The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.
CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable API to check the table status.
" - }, - "DeleteItem":{ - "name":"DeleteItem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteItemInput", - "documentation":"Represents the input of a DeleteItem operation.
" - }, - "output":{ - "shape":"DeleteItemOutput", - "documentation":"Represents the output of a DeleteItem operation.
" - }, - "errors":[ - { - "shape":"ConditionalCheckFailedException", - "exception":true, - "documentation":"A condition specified in the operation could not be evaluated.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
" - }, - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An error occurred on the server side.
" - } - ], - "documentation":"Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
" - }, - "DeleteTable":{ - "name":"DeleteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteTableInput", - "documentation":"Represents the input of a DeleteTable operation.
" - }, - "output":{ - "shape":"DeleteTableOutput", - "documentation":"Represents the output of a DeleteTable operation.
" - }, - "errors":[ - { - "shape":"ResourceInUseException", - "exception":true, - "documentation":"The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
An error occurred on the server side.
" - } - ], - "documentation":"The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
When you delete a table, any indexes on that table are also deleted.
Use the DescribeTable API to check the status of the table.
" - }, - "DescribeTable":{ - "name":"DescribeTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeTableInput", - "documentation":"Represents the input of a DescribeTable operation.
" - }, - "output":{ - "shape":"DescribeTableOutput", - "documentation":"Represents the output of a DescribeTable operation.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
" - } - ], - "documentation":"Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
" - }, - "GetItem":{ - "name":"GetItem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetItemInput", - "documentation":"Represents the input of a GetItem operation.
" - }, - "output":{ - "shape":"GetItemOutput", - "documentation":"Represents the output of a GetItem operation.
" - }, - "errors":[ - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
" - } - ], - "documentation":"The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data.
GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.
Represents the input of a ListTables operation.
" - }, - "output":{ - "shape":"ListTablesOutput", - "documentation":"Represents the output of a ListTables operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An error occurred on the server side.
" - } - ], - "documentation":"Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.
" - }, - "PutItem":{ - "name":"PutItem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PutItemInput", - "documentation":"Represents the input of a PutItem operation.
" - }, - "output":{ - "shape":"PutItemOutput", - "documentation":"Represents the output of a PutItem operation.
" - }, - "errors":[ - { - "shape":"ConditionalCheckFailedException", - "exception":true, - "documentation":"A condition specified in the operation could not be evaluated.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
" - }, - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An error occurred on the server side.
" - } - ], - "documentation":"Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.
In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.
You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.
For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.
" - }, - "Query":{ - "name":"Query", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"QueryInput", - "documentation":"Represents the input of a Query operation.
" - }, - "output":{ - "shape":"QueryOutput", - "documentation":"Represents the output of a Query operation.
" - }, - "errors":[ - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
" - } - ], - "documentation":"A Query operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the ScanIndexForward parameter to get results in forward or reverse order, by range key or by index key.
Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with LastEvaluatedKey to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey. The LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used Limit.
You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set ConsistentRead to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.
" - }, - "Scan":{ - "name":"Scan", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ScanInput", - "documentation":"Represents the input of a Scan operation.
" - }, - "output":{ - "shape":"ScanOutput", - "documentation":"Represents the output of a Scan operation.
" - }, - "errors":[ - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
" - } - ], - "documentation":"The Scan operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a ScanFilter operation.
If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.
The result set is eventually consistent.
By default, Scan operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel Scan operation by specifying the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.
" - }, - "UpdateItem":{ - "name":"UpdateItem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateItemInput", - "documentation":"Represents the input of an UpdateItem operation.
" - }, - "output":{ - "shape":"UpdateItemOutput", - "documentation":"Represents the output of an UpdateItem operation.
" - }, - "errors":[ - { - "shape":"ConditionalCheckFailedException", - "exception":true, - "documentation":"A condition specified in the operation could not be evaluated.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
" - }, - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An error occurred on the server side.
" - } - ], - "documentation":"Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.
" - }, - "UpdateTable":{ - "name":"UpdateTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateTableInput", - "documentation":"Represents the input of an UpdateTable operation.
" - }, - "output":{ - "shape":"UpdateTableOutput", - "documentation":"Represents the output of an UpdateTable operation.
" - }, - "errors":[ - { - "shape":"ResourceInUseException", - "exception":true, - "documentation":"The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
An error occurred on the server side.
" - } - ], - "documentation":"Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.
The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.
The table must be in the ACTIVE state for this operation to succeed. UpdateTable is an asynchronous operation; while executing the operation, the table is in the UPDATING state. While the table is in the UPDATING state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the ACTIVE state after the UpdateTable operation.
You cannot add, modify or delete indexes using UpdateTable. Indexes can only be defined at table creation time.
" - } - }, - "shapes":{ - "AttributeAction":{ - "type":"string", - "enum":[ - "ADD", - "PUT", - "DELETE" - ] - }, - "AttributeDefinition":{ - "type":"structure", - "required":[ - "AttributeName", - "AttributeType" - ], - "members":{ - "AttributeName":{ - "shape":"KeySchemaAttributeName", - "documentation":"A name for the attribute.
" - }, - "AttributeType":{ - "shape":"ScalarAttributeType", - "documentation":"The data type for the attribute.
" - } - }, - "documentation":"Represents an attribute for describing the key schema for the table and indexes.
" - }, - "AttributeDefinitions":{ - "type":"list", - "member":{"shape":"AttributeDefinition"} - }, - "AttributeMap":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"AttributeValue"} - }, - "AttributeName":{ - "type":"string", - "max":65535 - }, - "AttributeNameList":{ - "type":"list", - "member":{"shape":"AttributeName"}, - "min":1 - }, - "AttributeUpdates":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"AttributeValueUpdate"} - }, - "AttributeValue":{ - "type":"structure", - "members":{ - "S":{ - "shape":"StringAttributeValue", - "documentation":"A String data type.
" - }, - "N":{ - "shape":"NumberAttributeValue", - "documentation":"A Number data type.
" - }, - "B":{ - "shape":"BinaryAttributeValue", - "documentation":"A Binary data type.
" - }, - "SS":{ - "shape":"StringSetAttributeValue", - "documentation":"A String Set data type.
" - }, - "NS":{ - "shape":"NumberSetAttributeValue", - "documentation":"A Number Set data type.
" - }, - "BS":{ - "shape":"BinarySetAttributeValue", - "documentation":"A Binary Set data type.
" - }, - "M":{ - "shape":"MapAttributeValue", - "documentation":"A Map of attribute values.
" - }, - "L":{ - "shape":"ListAttributeValue", - "documentation":"A List of attribute values.
" - }, - "NULL":{ - "shape":"NullAttributeValue", - "documentation":"A Null data type.
" - }, - "BOOL":{ - "shape":"BooleanAttributeValue", - "documentation":"A Boolean data type.
" - } - }, - "documentation":"Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
" - }, - "AttributeValueList":{ - "type":"list", - "member":{"shape":"AttributeValue"} - }, - "AttributeValueUpdate":{ - "type":"structure", - "members":{ - "Value":{"shape":"AttributeValue"}, - "Action":{ - "shape":"AttributeAction", - "documentation":"Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.
If no item with the specified Key is found:
PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.
DELETE - Nothing happens; there is no attribute to delete.
ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.
Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
" - }, - "BatchGetItemInput":{ - "type":"structure", - "required":["RequestItems"], - "members":{ - "RequestItems":{ - "shape":"BatchGetRequestMap", - "documentation":"A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
Each element in the map consists of the following:
Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
Represents the input of a BatchGetItem operation.
" - }, - "BatchGetItemOutput":{ - "type":"structure", - "members":{ - "Responses":{ - "shape":"BatchGetResponseMap", - "documentation":"A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
" - }, - "UnprocessedKeys":{ - "shape":"BatchGetRequestMap", - "documentation":"A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
" - }, - "ConsumedCapacity":{ - "shape":"ConsumedCapacityMultiple", - "documentation":"The write capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Represents the output of a BatchGetItem operation.
" - }, - "BatchGetRequestMap":{ - "type":"map", - "key":{"shape":"TableName"}, - "value":{"shape":"KeysAndAttributes"}, - "min":1, - "max":100 - }, - "BatchGetResponseMap":{ - "type":"map", - "key":{"shape":"TableName"}, - "value":{"shape":"ItemList"} - }, - "BatchWriteItemInput":{ - "type":"structure", - "required":["RequestItems"], - "members":{ - "RequestItems":{ - "shape":"BatchWriteItemRequestMap", - "documentation":"A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
Represents the input of a BatchWriteItem operation.
" - }, - "BatchWriteItemOutput":{ - "type":"structure", - "members":{ - "UnprocessedItems":{ - "shape":"BatchWriteItemRequestMap", - "documentation":"A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
" - }, - "ItemCollectionMetrics":{ - "shape":"ItemCollectionMetricsPerTable", - "documentation":"A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
The capacity units consumed by the operation.
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Represents the output of a BatchWriteItem operation.
" - }, - "BatchWriteItemRequestMap":{ - "type":"map", - "key":{"shape":"TableName"}, - "value":{"shape":"WriteRequests"}, - "min":1, - "max":25 - }, - "BinaryAttributeValue":{"type":"blob"}, - "BinarySetAttributeValue":{ - "type":"list", - "member":{"shape":"BinaryAttributeValue"} - }, - "BooleanAttributeValue":{"type":"boolean"}, - "BooleanObject":{"type":"boolean"}, - "Capacity":{ - "type":"structure", - "members":{ - "CapacityUnits":{ - "shape":"ConsumedCapacityUnits", - "documentation":"The total number of capacity units consumed on a table or an index.
" - } - }, - "documentation":"Represents the amount of provisioned throughput capacity consumed on a table or an index.
" - }, - "ComparisonOperator":{ - "type":"string", - "enum":[ - "EQ", - "NE", - "IN", - "LE", - "LT", - "GE", - "GT", - "BETWEEN", - "NOT_NULL", - "NULL", - "CONTAINS", - "NOT_CONTAINS", - "BEGINS_WITH" - ] - }, - "Condition":{ - "type":"structure", - "required":["ComparisonOperator"], - "members":{ - "AttributeValueList":{ - "shape":"AttributeValueList", - "documentation":"One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
" - }, - "ComparisonOperator":{ - "shape":"ComparisonOperator", - "documentation":"A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
" - } - }, - "documentation":"Represents the selection criteria for a Query or Scan operation:
For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values.
For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.
The conditional request failed.
" - } - }, - "exception":true, - "documentation":"A condition specified in the operation could not be evaluated.
" - }, - "ConditionalOperator":{ - "type":"string", - "enum":[ - "AND", - "OR" - ] - }, - "ConsistentRead":{"type":"boolean"}, - "ConsumedCapacity":{ - "type":"structure", - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table that was affected by the operation.
" - }, - "CapacityUnits":{ - "shape":"ConsumedCapacityUnits", - "documentation":"The total number of capacity units consumed by the operation.
" - }, - "Table":{ - "shape":"Capacity", - "documentation":"The amount of throughput consumed on the table affected by the operation.
" - }, - "LocalSecondaryIndexes":{ - "shape":"SecondaryIndexesCapacityMap", - "documentation":"The amount of throughput consumed on each local index affected by the operation.
" - }, - "GlobalSecondaryIndexes":{ - "shape":"SecondaryIndexesCapacityMap", - "documentation":"The amount of throughput consumed on each global index affected by the operation.
" - } - }, - "documentation":"The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
" - }, - "ConsumedCapacityMultiple":{ - "type":"list", - "member":{"shape":"ConsumedCapacity"} - }, - "ConsumedCapacityUnits":{"type":"double"}, - "CreateTableInput":{ - "type":"structure", - "required":[ - "AttributeDefinitions", - "TableName", - "KeySchema", - "ProvisionedThroughput" - ], - "members":{ - "AttributeDefinitions":{ - "shape":"AttributeDefinitions", - "documentation":"An array of attributes that describe the key schema for the table and indexes.
" - }, - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table to create.
" - }, - "KeySchema":{ - "shape":"KeySchema", - "documentation":"Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is HASH or RANGE.
For a primary key that consists of a hash attribute, you must specify exactly one element with a KeyType of HASH.
For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
" - }, - "LocalSecondaryIndexes":{ - "shape":"LocalSecondaryIndexList", - "documentation":"One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 GB size limit per hash key; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
Represents the input of a CreateTable operation.
" - }, - "CreateTableOutput":{ - "type":"structure", - "members":{ - "TableDescription":{"shape":"TableDescription"} - }, - "documentation":"Represents the output of a CreateTable operation.
" - }, - "Date":{"type":"timestamp"}, - "DeleteItemInput":{ - "type":"structure", - "required":[ - "TableName", - "Key" - ], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table from which to delete the item.
" - }, - "Key":{ - "shape":"Key", - "documentation":"A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
" - }, - "Expected":{ - "shape":"ExpectedAttributeMap", - "documentation":"There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
" - }, - "ConditionalOperator":{ - "shape":"ConditionalOperator", - "documentation":"There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
" - }, - "ReturnValues":{ - "shape":"ReturnValue", - "documentation":"Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: NOT | AND | OR
One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
One or more values that can be substituted in an expression.
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN (\"Available\",\"Backordered\",\"Discontinued\")
Now suppose that you specified the following for ExpressionAttributeValues:
{ \"a\":{\"S\":\"Available\"}, \"b\":{\"S\":\"Backordered\"}, \"d\":{\"S\":\"Discontinued\"} }
The expression can now be simplified as follows:
ProductStatus IN (:a,:b,:c)
Represents the input of a DeleteItem operation.
" - }, - "DeleteItemOutput":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"AttributeMap", - "documentation":"A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Represents the output of a DeleteItem operation.
" - }, - "DeleteRequest":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"Key", - "documentation":"A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
" - } - }, - "documentation":"Represents a request to perform a DeleteItem operation on an item.
" - }, - "DeleteTableInput":{ - "type":"structure", - "required":["TableName"], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table to delete.
" - } - }, - "documentation":"Represents the input of a DeleteTable operation.
" - }, - "DeleteTableOutput":{ - "type":"structure", - "members":{ - "TableDescription":{"shape":"TableDescription"} - }, - "documentation":"Represents the output of a DeleteTable operation.
" - }, - "DescribeTableInput":{ - "type":"structure", - "required":["TableName"], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table to describe.
" - } - }, - "documentation":"Represents the input of a DescribeTable operation.
" - }, - "DescribeTableOutput":{ - "type":"structure", - "members":{ - "Table":{"shape":"TableDescription"} - }, - "documentation":"Represents the output of a DescribeTable operation.
" - }, - "ErrorMessage":{"type":"string"}, - "ExpectedAttributeMap":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"ExpectedAttributeValue"} - }, - "ExpectedAttributeValue":{ - "type":"structure", - "members":{ - "Value":{"shape":"AttributeValue"}, - "Exists":{ - "shape":"BooleanObject", - "documentation":"Causes DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.
The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.
DynamoDB returns a ValidationException if:
Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)
Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
" - } - }, - "documentation":"Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:
Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.
>Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.
Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
" - }, - "ExpressionAttributeNameMap":{ - "type":"map", - "key":{"shape":"ExpressionAttributeNameVariable"}, - "value":{"shape":"AttributeName"} - }, - "ExpressionAttributeNameVariable":{"type":"string"}, - "ExpressionAttributeValueMap":{ - "type":"map", - "key":{"shape":"ExpressionAttributeValueVariable"}, - "value":{"shape":"AttributeValue"} - }, - "ExpressionAttributeValueVariable":{"type":"string"}, - "FilterConditionMap":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"Condition"} - }, - "GetItemInput":{ - "type":"structure", - "required":[ - "TableName", - "Key" - ], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table containing the requested item.
" - }, - "Key":{ - "shape":"Key", - "documentation":"A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
" - }, - "AttributesToGet":{ - "shape":"AttributeNameList", - "documentation":"There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
" - }, - "ConsistentRead":{ - "shape":"ConsistentRead", - "documentation":"A value that if set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.
One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
" - }, - "ExpressionAttributeNames":{ - "shape":"ExpressionAttributeNameMap", - "documentation":"One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
Represents the input of a GetItem operation.
" - }, - "GetItemOutput":{ - "type":"structure", - "members":{ - "Item":{ - "shape":"AttributeMap", - "documentation":"A map of attribute names to AttributeValue objects, as specified by AttributesToGet.
" - }, - "ConsumedCapacity":{"shape":"ConsumedCapacity"} - }, - "documentation":"Represents the output of a GetItem operation.
" - }, - "GlobalSecondaryIndex":{ - "type":"structure", - "required":[ - "IndexName", - "KeySchema", - "Projection", - "ProvisionedThroughput" - ], - "members":{ - "IndexName":{ - "shape":"IndexName", - "documentation":"The name of the global secondary index. The name must be unique among all other indexes on this table.
" - }, - "KeySchema":{ - "shape":"KeySchema", - "documentation":"The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
Represents a global secondary index.
" - }, - "GlobalSecondaryIndexDescription":{ - "type":"structure", - "members":{ - "IndexName":{ - "shape":"IndexName", - "documentation":"The name of the global secondary index.
" - }, - "KeySchema":{ - "shape":"KeySchema", - "documentation":"The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
The current state of the global secondary index:
CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.
UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.
DELETING - The index is being deleted, as the result of a DeleteTable operation.
ACTIVE - The index is ready for use.
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" - }, - "ItemCount":{ - "shape":"Long", - "documentation":"The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" - } - }, - "documentation":"Represents the properties of a global secondary index.
" - }, - "GlobalSecondaryIndexDescriptionList":{ - "type":"list", - "member":{"shape":"GlobalSecondaryIndexDescription"} - }, - "GlobalSecondaryIndexList":{ - "type":"list", - "member":{"shape":"GlobalSecondaryIndex"} - }, - "GlobalSecondaryIndexUpdate":{ - "type":"structure", - "members":{ - "Update":{ - "shape":"UpdateGlobalSecondaryIndexAction", - "documentation":"The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.
" - } - }, - "documentation":"Represents the new provisioned throughput settings to apply to a global secondary index.
" - }, - "GlobalSecondaryIndexUpdateList":{ - "type":"list", - "member":{"shape":"GlobalSecondaryIndexUpdate"} - }, - "IndexName":{ - "type":"string", - "min":3, - "max":255, - "pattern":"[a-zA-Z0-9_.-]+" - }, - "IndexStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE" - ] - }, - "Integer":{"type":"integer"}, - "InternalServerError":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"The server encountered an internal error trying to fulfill the request.
" - } - }, - "exception":true, - "fault":true, - "documentation":"An error occurred on the server side.
" - }, - "ItemCollectionKeyAttributeMap":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"AttributeValue"} - }, - "ItemCollectionMetrics":{ - "type":"structure", - "members":{ - "ItemCollectionKey":{ - "shape":"ItemCollectionKeyAttributeMap", - "documentation":"The hash key value of the item collection. This value is the same as the hash key of the item.
" - }, - "SizeEstimateRangeGB":{ - "shape":"ItemCollectionSizeEstimateRange", - "documentation":"An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
" - } - }, - "documentation":"Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
" - }, - "ItemCollectionMetricsMultiple":{ - "type":"list", - "member":{"shape":"ItemCollectionMetrics"} - }, - "ItemCollectionMetricsPerTable":{ - "type":"map", - "key":{"shape":"TableName"}, - "value":{"shape":"ItemCollectionMetricsMultiple"} - }, - "ItemCollectionSizeEstimateBound":{"type":"double"}, - "ItemCollectionSizeEstimateRange":{ - "type":"list", - "member":{"shape":"ItemCollectionSizeEstimateBound"} - }, - "ItemCollectionSizeLimitExceededException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
" - } - }, - "exception":true, - "documentation":"An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
" - }, - "ItemList":{ - "type":"list", - "member":{"shape":"AttributeMap"} - }, - "Key":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"AttributeValue"} - }, - "KeyConditions":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"Condition"} - }, - "KeyList":{ - "type":"list", - "member":{"shape":"Key"}, - "min":1, - "max":100 - }, - "KeySchema":{ - "type":"list", - "member":{"shape":"KeySchemaElement"}, - "min":1, - "max":2 - }, - "KeySchemaAttributeName":{ - "type":"string", - "min":1, - "max":255 - }, - "KeySchemaElement":{ - "type":"structure", - "required":[ - "AttributeName", - "KeyType" - ], - "members":{ - "AttributeName":{ - "shape":"KeySchemaAttributeName", - "documentation":"The name of a key attribute.
" - }, - "KeyType":{ - "shape":"KeyType", - "documentation":"The attribute data, consisting of the data type and the attribute value itself.
" - } - }, - "documentation":"Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a hash type primary key would be represented by one KeySchemaElement. A hash-and-range type primary key would require one KeySchemaElement for the hash attribute, and another KeySchemaElement for the range attribute.
" - }, - "KeyType":{ - "type":"string", - "enum":[ - "HASH", - "RANGE" - ] - }, - "KeysAndAttributes":{ - "type":"structure", - "required":["Keys"], - "members":{ - "Keys":{ - "shape":"KeyList", - "documentation":"The primary key attribute values that define the items and the attributes associated with the items.
" - }, - "AttributesToGet":{ - "shape":"AttributeNameList", - "documentation":"One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
" - }, - "ConsistentRead":{ - "shape":"ConsistentRead", - "documentation":"The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
" - }, - "ExpressionAttributeNames":{ - "shape":"ExpressionAttributeNameMap", - "documentation":"One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
Represents a set of primary keys and, for each key, the attributes to retrieve from the table.
For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Too many operations for a given subscriber.
" - } - }, - "exception":true, - "documentation":"The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.
Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.
The total limit of tables in the ACTIVE state is 250.
The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
" - }, - "Limit":{ - "shape":"ListTablesInputLimit", - "documentation":"A maximum number of table names to return. If this parameter is not specified, the limit is 100.
" - } - }, - "documentation":"Represents the input of a ListTables operation.
" - }, - "ListTablesInputLimit":{ - "type":"integer", - "min":1, - "max":100 - }, - "ListTablesOutput":{ - "type":"structure", - "members":{ - "TableNames":{ - "shape":"TableNameList", - "documentation":"The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
" - }, - "LastEvaluatedTableName":{ - "shape":"TableName", - "documentation":"The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
" - } - }, - "documentation":"Represents the output of a ListTables operation.
" - }, - "LocalSecondaryIndex":{ - "type":"structure", - "required":[ - "IndexName", - "KeySchema", - "Projection" - ], - "members":{ - "IndexName":{ - "shape":"IndexName", - "documentation":"The name of the local secondary index. The name must be unique among all other indexes on this table.
" - }, - "KeySchema":{ - "shape":"KeySchema", - "documentation":"The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
Represents a local secondary index.
" - }, - "LocalSecondaryIndexDescription":{ - "type":"structure", - "members":{ - "IndexName":{ - "shape":"IndexName", - "documentation":"Represents the name of the local secondary index.
" - }, - "KeySchema":{ - "shape":"KeySchema", - "documentation":"The complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" - }, - "ItemCount":{ - "shape":"Long", - "documentation":"The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" - } - }, - "documentation":"Represents the properties of a local secondary index.
" - }, - "LocalSecondaryIndexDescriptionList":{ - "type":"list", - "member":{"shape":"LocalSecondaryIndexDescription"} - }, - "LocalSecondaryIndexList":{ - "type":"list", - "member":{"shape":"LocalSecondaryIndex"} - }, - "Long":{"type":"long"}, - "MapAttributeValue":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"AttributeValue"} - }, - "NonKeyAttributeName":{ - "type":"string", - "min":1, - "max":255 - }, - "NonKeyAttributeNameList":{ - "type":"list", - "member":{"shape":"NonKeyAttributeName"}, - "min":1, - "max":20 - }, - "NullAttributeValue":{"type":"boolean"}, - "NumberAttributeValue":{"type":"string"}, - "NumberSetAttributeValue":{ - "type":"list", - "member":{"shape":"NumberAttributeValue"} - }, - "PositiveIntegerObject":{ - "type":"integer", - "min":1 - }, - "PositiveLongObject":{ - "type":"long", - "min":1 - }, - "Projection":{ - "type":"structure", - "members":{ - "ProjectionType":{ - "shape":"ProjectionType", - "documentation":"The set of attributes that are projected into the index:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
Represents the non-key attribute names which will be projected into the index.
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
" - } - }, - "documentation":"Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
" - }, - "ProjectionExpression":{"type":"string"}, - "ProjectionType":{ - "type":"string", - "enum":[ - "ALL", - "KEYS_ONLY", - "INCLUDE" - ] - }, - "ProvisionedThroughput":{ - "type":"structure", - "required":[ - "ReadCapacityUnits", - "WriteCapacityUnits" - ], - "members":{ - "ReadCapacityUnits":{ - "shape":"PositiveLongObject", - "documentation":"The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
" - }, - "WriteCapacityUnits":{ - "shape":"PositiveLongObject", - "documentation":"The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
" - } - }, - "documentation":"Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
" - }, - "ProvisionedThroughputDescription":{ - "type":"structure", - "members":{ - "LastIncreaseDateTime":{ - "shape":"Date", - "documentation":"The date and time of the last provisioned throughput increase for this table.
" - }, - "LastDecreaseDateTime":{ - "shape":"Date", - "documentation":"The date and time of the last provisioned throughput decrease for this table.
" - }, - "NumberOfDecreasesToday":{ - "shape":"PositiveLongObject", - "documentation":"The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
" - }, - "ReadCapacityUnits":{ - "shape":"PositiveLongObject", - "documentation":"The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
" - }, - "WriteCapacityUnits":{ - "shape":"PositiveLongObject", - "documentation":"The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
" - } - }, - "documentation":"Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
" - }, - "ProvisionedThroughputExceededException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"You exceeded your maximum allowed provisioned throughput.
" - } - }, - "exception":true, - "documentation":"The request rate is too high, or the request is too large, for the available throughput to accommodate. The AWS SDKs automatically retry requests that receive this exception; therefore, your request will eventually succeed, unless the request is too large or your retry queue is too large to finish. Reduce the frequency of requests by using the strategies listed in Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
" - }, - "PutItemInput":{ - "type":"structure", - "required":[ - "TableName", - "Item" - ], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table to contain the item.
" - }, - "Item":{ - "shape":"PutItemInputAttributeMap", - "documentation":"A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
" - }, - "Expected":{ - "shape":"ExpectedAttributeMap", - "documentation":"There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
" - }, - "ReturnValues":{ - "shape":"ReturnValue", - "documentation":"Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
" - }, - "ConditionExpression":{ - "shape":"ConditionExpression", - "documentation":"A condition that must be satisfied in order for a conditional PutItem operation to succeed.
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: NOT | AND | OR
One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
One or more values that can be substituted in an expression.
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN (\"Available\",\"Backordered\",\"Discontinued\")
Now suppose that you specified the following for ExpressionAttributeValues:
{ \"a\":{\"S\":\"Available\"}, \"b\":{\"S\":\"Backordered\"}, \"d\":{\"S\":\"Discontinued\"} }
The expression can now be simplified as follows:
ProductStatus IN (:a,:b,:c)
Represents the input of a PutItem operation.
" - }, - "PutItemInputAttributeMap":{ - "type":"map", - "key":{"shape":"AttributeName"}, - "value":{"shape":"AttributeValue"} - }, - "PutItemOutput":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"AttributeMap", - "documentation":"The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Represents the output of a PutItem operation.
" - }, - "PutRequest":{ - "type":"structure", - "required":["Item"], - "members":{ - "Item":{ - "shape":"PutItemInputAttributeMap", - "documentation":"A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.
" - } - }, - "documentation":"Represents a request to perform a PutItem operation on an item.
" - }, - "QueryInput":{ - "type":"structure", - "required":[ - "TableName", - "KeyConditions" - ], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table containing the requested items.
" - }, - "IndexName":{ - "shape":"IndexName", - "documentation":"The name of an index to query. This index can be any local secondary index or global secondary index on the table.
" - }, - "Select":{ - "shape":"Select", - "documentation":"The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.
COUNT - Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
" - }, - "Limit":{ - "shape":"PositiveIntegerObject", - "documentation":"The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
" - }, - "ConsistentRead":{ - "shape":"ConsistentRead", - "documentation":"A value that if set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive an error message.
The selection criteria for the query. For a query on a table, you can have conditions only on the table primary key attributes. You must specify the hash key attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the range key attribute.
For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
" - }, - "QueryFilter":{ - "shape":"FilterConditionMap", - "documentation":"There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
" - }, - "ScanIndexForward":{ - "shape":"BooleanObject", - "documentation":"A value that specifies ascending (true) or descending (false) traversal of the index. DynamoDB returns results reflecting the requested order determined by the range key. If the data type is Number, the results are returned in numeric order. For type String, the results are returned in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
If ScanIndexForward is not specified, the results are returned in ascending order.
" - }, - "ExclusiveStartKey":{ - "shape":"Key", - "documentation":"The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
" - }, - "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, - "ProjectionExpression":{ - "shape":"ProjectionExpression", - "documentation":"One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
" - }, - "FilterExpression":{ - "shape":"ConditionExpression", - "documentation":"A condition that evaluates the query results and returns only the desired values.
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
" - }, - "ExpressionAttributeNames":{ - "shape":"ExpressionAttributeNameMap", - "documentation":"One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
One or more values that can be substituted in an expression.
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN (\"Available\",\"Backordered\",\"Discontinued\")
Now suppose that you specified the following for ExpressionAttributeValues:
{ \"a\":{\"S\":\"Available\"}, \"b\":{\"S\":\"Backordered\"}, \"d\":{\"S\":\"Discontinued\"} }
The expression can now be simplified as follows:
ProductStatus IN (:a,:b,:c)
Represents the input of a Query operation.
" - }, - "QueryOutput":{ - "type":"structure", - "members":{ - "Items":{ - "shape":"ItemList", - "documentation":"An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
" - }, - "Count":{ - "shape":"Integer", - "documentation":"The number of items in the response.
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
" - }, - "ScannedCount":{ - "shape":"Integer", - "documentation":"The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
" - }, - "LastEvaluatedKey":{ - "shape":"Key", - "documentation":"The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
" - }, - "ConsumedCapacity":{"shape":"ConsumedCapacity"} - }, - "documentation":"Represents the output of a Query operation.
" - }, - "ResourceInUseException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"The resource which is being attempted to be changed is in use.
" - } - }, - "exception":true, - "documentation":"The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
The resource which is being requested does not exist.
" - } - }, - "exception":true, - "documentation":"The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
The name of the table containing the requested items.
" - }, - "AttributesToGet":{ - "shape":"AttributeNameList", - "documentation":"There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
" - }, - "Limit":{ - "shape":"PositiveIntegerObject", - "documentation":"The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
" - }, - "Select":{ - "shape":"Select", - "documentation":"The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES - Returns all of the item attributes.
COUNT - Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES. You cannot use both AttributesToGet and Select together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
" - }, - "ExclusiveStartKey":{ - "shape":"Key", - "documentation":"The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
" - }, - "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, - "TotalSegments":{ - "shape":"ScanTotalSegments", - "documentation":"For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to scan a table using four application threads, specify a TotalSegments value of 4.
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
" - }, - "Segment":{ - "shape":"ScanSegment", - "documentation":"For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
" - }, - "ProjectionExpression":{ - "shape":"ProjectionExpression", - "documentation":"One or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
" - }, - "FilterExpression":{ - "shape":"ConditionExpression", - "documentation":"A condition that evaluates the scan results and returns only the desired values.
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
" - }, - "ExpressionAttributeNames":{ - "shape":"ExpressionAttributeNameMap", - "documentation":"One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
One or more values that can be substituted in an expression.
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN (\"Available\",\"Backordered\",\"Discontinued\")
Now suppose that you specified the following for ExpressionAttributeValues:
{ \"a\":{\"S\":\"Available\"}, \"b\":{\"S\":\"Backordered\"}, \"d\":{\"S\":\"Discontinued\"} }
The expression can now be simplified as follows:
ProductStatus IN (:a,:b,:c)
Represents the input of a Scan operation.
" - }, - "ScanOutput":{ - "type":"structure", - "members":{ - "Items":{ - "shape":"ItemList", - "documentation":"An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
" - }, - "Count":{ - "shape":"Integer", - "documentation":"The number of items in the response.
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
" - }, - "ScannedCount":{ - "shape":"Integer", - "documentation":"The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
" - }, - "LastEvaluatedKey":{ - "shape":"Key", - "documentation":"The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
" - }, - "ConsumedCapacity":{"shape":"ConsumedCapacity"} - }, - "documentation":"Represents the output of a Scan operation.
" - }, - "ScanSegment":{ - "type":"integer", - "min":0, - "max":999999 - }, - "ScanTotalSegments":{ - "type":"integer", - "min":1, - "max":1000000 - }, - "SecondaryIndexesCapacityMap":{ - "type":"map", - "key":{"shape":"IndexName"}, - "value":{"shape":"Capacity"} - }, - "Select":{ - "type":"string", - "enum":[ - "ALL_ATTRIBUTES", - "ALL_PROJECTED_ATTRIBUTES", - "SPECIFIC_ATTRIBUTES", - "COUNT" - ] - }, - "StringAttributeValue":{"type":"string"}, - "StringSetAttributeValue":{ - "type":"list", - "member":{"shape":"StringAttributeValue"} - }, - "TableDescription":{ - "type":"structure", - "members":{ - "AttributeDefinitions":{ - "shape":"AttributeDefinitions", - "documentation":"An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
The name of the table.
" - }, - "KeySchema":{ - "shape":"KeySchema", - "documentation":"The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The key type for the attribute. Can be either HASH or RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
" - }, - "TableStatus":{ - "shape":"TableStatus", - "documentation":"The current state of the table:
CREATING - The table is being created, as the result of a CreateTable operation.
UPDATING - The table is being updated, as the result of an UpdateTable operation.
DELETING - The table is being deleted, as the result of a DeleteTable operation.
ACTIVE - The table is ready for use.
The date and time when the table was created, in UNIX epoch time format.
" - }, - "ProvisionedThroughput":{ - "shape":"ProvisionedThroughputDescription", - "documentation":"The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
" - }, - "TableSizeBytes":{ - "shape":"Long", - "documentation":"The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" - }, - "ItemCount":{ - "shape":"Long", - "documentation":"The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
" - }, - "LocalSecondaryIndexes":{ - "shape":"LocalSecondaryIndexDescriptionList", - "documentation":"Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING state, no information about indexes will be returned.
The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING state, no information about indexes will be returned.
Represents the properties of a table.
" - }, - "TableName":{ - "type":"string", - "min":3, - "max":255, - "pattern":"[a-zA-Z0-9_.-]+" - }, - "TableNameList":{ - "type":"list", - "member":{"shape":"TableName"} - }, - "TableStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "DELETING", - "ACTIVE" - ] - }, - "UpdateExpression":{"type":"string"}, - "UpdateGlobalSecondaryIndexAction":{ - "type":"structure", - "required":[ - "IndexName", - "ProvisionedThroughput" - ], - "members":{ - "IndexName":{ - "shape":"IndexName", - "documentation":"The name of the global secondary index to be updated.
" - }, - "ProvisionedThroughput":{"shape":"ProvisionedThroughput"} - }, - "documentation":"Represents the new provisioned throughput settings to be applied to a global secondary index.
" - }, - "UpdateItemInput":{ - "type":"structure", - "required":[ - "TableName", - "Key" - ], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table containing the item to update.
" - }, - "Key":{ - "shape":"Key", - "documentation":"The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
" - }, - "AttributeUpdates":{ - "shape":"AttributeUpdates", - "documentation":"There is a newer parameter available. Use UpdateExpression instead. Note that if you use AttributeUpdates and UpdateExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any nonkey attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use ADD for other data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
DELETE - Removes the attribute and its value, if no value is specified for DELETE. The data type of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If the existing data type is a set, and if Value is also a set, then Value is appended to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
PUT - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute.
DELETE - Causes nothing to happen; there is no attribute to delete.
ADD - Causes DynamoDB to creat an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
" - }, - "Expected":{ - "shape":"ExpectedAttributeMap", - "documentation":"There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
NE : Not equal. NE is supported for all datatypes, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one specified in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
" - }, - "ConditionalOperator":{ - "shape":"ConditionalOperator", - "documentation":"There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to true.
" - }, - "ReturnValues":{ - "shape":"ReturnValue", - "documentation":"Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
UPDATED_OLD - The old versions of only the updated attributes are returned.
ALL_NEW - All of the attributes of the new version of the item are returned.
UPDATED_NEW - The new versions of only the updated attributes are returned.
A value that if set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
The following action values are available for UpdateExpression.
SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number.
SET supports the following functions:
if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE - Removes one or more attributes from an item.
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
DELETE - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.
The DELETE action only supports Number and set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: NOT | AND | OR
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: NOT | AND | OR
One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = \"Smith\" OR order.customerInfo.LastName = \"Jones\"
Now suppose that you specified the following for ExpressionAttributeNames:
{\"n\":\"order.customerInfo.LastName\"}
The expression can now be simplified as follows:
#n = \"Smith\" OR #n = \"Jones\"
One or more values that can be substituted in an expression.
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN (\"Available\",\"Backordered\",\"Discontinued\")
Now suppose that you specified the following for ExpressionAttributeValues:
{ \"a\":{\"S\":\"Available\"}, \"b\":{\"S\":\"Backordered\"}, \"d\":{\"S\":\"Discontinued\"} }
The expression can now be simplified as follows:
ProductStatus IN (:a,:b,:c)
Represents the input of an UpdateItem operation.
" - }, - "UpdateItemOutput":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"AttributeMap", - "documentation":"A map of attribute values as they appeared before the UpdateItem operation. This map only appears if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.
Represents the output of an UpdateItem operation.
" - }, - "UpdateTableInput":{ - "type":"structure", - "required":["TableName"], - "members":{ - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table to be updated.
" - }, - "ProvisionedThroughput":{"shape":"ProvisionedThroughput"}, - "GlobalSecondaryIndexUpdates":{ - "shape":"GlobalSecondaryIndexUpdateList", - "documentation":"An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
" - } - }, - "documentation":"Represents the input of an UpdateTable operation.
" - }, - "UpdateTableOutput":{ - "type":"structure", - "members":{ - "TableDescription":{"shape":"TableDescription"} - }, - "documentation":"Represents the output of an UpdateTable operation.
" - }, - "WriteRequest":{ - "type":"structure", - "members":{ - "PutRequest":{ - "shape":"PutRequest", - "documentation":"A request to perform a PutItem operation.
" - }, - "DeleteRequest":{ - "shape":"DeleteRequest", - "documentation":"A request to perform a DeleteItem operation.
" - } - }, - "documentation":"Represents an operation to perform - either DeleteItem or PutItem. You can only specify one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to specify two separate WriteRequest objects.
" - }, - "WriteRequests":{ - "type":"list", - "member":{"shape":"WriteRequest"}, - "min":1, - "max":25 - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.paginators.json deleted file mode 100644 index bb986d114f..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.paginators.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "pagination": { - "ListTables": { - "input_token": "ExclusiveStartTableName", - "output_token": "LastEvaluatedTableName", - "limit_key": "Limit", - "result_key": "TableNames" - }, - "Query": { - "input_token": "ExclusiveStartKey", - "output_token": "LastEvaluatedKey", - "limit_key": "Limit", - "result_key": "Items", - "non_aggregate_keys": [ - "Count", - "ScannedCount", - "ConsumedCapacity" - ] - }, - "Scan": { - "input_token": "ExclusiveStartKey", - "output_token": "LastEvaluatedKey", - "limit_key": "Limit", - "result_key": "Items", - "non_aggregate_keys": [ - "Count", - "ScannedCount", - "ConsumedCapacity" - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.waiters.json deleted file mode 100644 index 43a55ca7bd..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/dynamodb/2012-08-10.waiters.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "version": 2, - "waiters": { - "TableExists": { - "delay": 20, - "operation": "DescribeTable", - "maxAttempts": 25, - "acceptors": [ - { - "expected": "ACTIVE", - "matcher": "path", - "state": "success", - "argument": "Table.TableStatus" - }, - { - "expected": "ResourceNotFoundException", - "matcher": "error", - "state": "retry" - } - ] - }, - "TableNotExists": { - "delay": 20, - "operation": "DescribeTable", - "maxAttempts": 25, - "acceptors": [ - { - "expected": "ResourceNotFoundException", - "matcher": "error", - "state": "success" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.normal.json deleted file mode 100644 index 7c92d3a638..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.normal.json +++ /dev/null @@ -1,11699 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-09-01", - "endpointPrefix":"ec2", - "serviceAbbreviation":"Amazon EC2", - "serviceFullName":"Amazon Elastic Compute Cloud", - "signatureVersion":"v4", - "xmlNamespace":"http://ec2.amazonaws.com/doc/2014-09-01", - "protocol":"ec2" - }, - "documentation":"Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.
", - "operations":{ - "AcceptVpcPeeringConnection":{ - "name":"AcceptVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, - "output":{"shape":"AcceptVpcPeeringConnectionResult"}, - "documentation":"Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.
Acquires an Elastic IP address.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
" - }, - "AssignPrivateIpAddresses":{ - "name":"AssignPrivateIpAddresses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssignPrivateIpAddressesRequest"}, - "documentation":"Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
AssignPrivateIpAddresses is available only in EC2-VPC.
" - }, - "AssociateAddress":{ - "name":"AssociateAddress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateAddressRequest"}, - "output":{"shape":"AssociateAddressResult"}, - "documentation":"Associates an Elastic IP address with an instance or a network interface.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" - }, - "AssociateDhcpOptions":{ - "name":"AssociateDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateDhcpOptionsRequest"}, - "documentation":"Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
" - }, - "AssociateRouteTable":{ - "name":"AssociateRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateRouteTableRequest"}, - "output":{"shape":"AssociateRouteTableResult"}, - "documentation":"Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "AttachInternetGateway":{ - "name":"AttachInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachInternetGatewayRequest"}, - "documentation":"Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.
" - }, - "AttachNetworkInterface":{ - "name":"AttachNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachNetworkInterfaceRequest"}, - "output":{"shape":"AttachNetworkInterfaceResult"}, - "documentation":"Attaches a network interface to an instance.
" - }, - "AttachVolume":{ - "name":"AttachVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachVolumeRequest"}, - "output":{ - "shape":"VolumeAttachment", - "locationName":"attachment" - }, - "documentation":"Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.
If a volume has an AWS Marketplace product code:
For an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For more information about how to use the AWS Marketplace, see AWS Marketplace.
For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
" - }, - "AttachVpnGateway":{ - "name":"AttachVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachVpnGatewayRequest"}, - "output":{"shape":"AttachVpnGatewayResult"}, - "documentation":"Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "AuthorizeSecurityGroupEgress":{ - "name":"AuthorizeSecurityGroupEgress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, - "documentation":"Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.
You can have up to 50 rules per security group (covering both ingress and egress rules).
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
" - }, - "AuthorizeSecurityGroupIngress":{ - "name":"AuthorizeSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, - "documentation":"Adds one or more ingress rules to a security group.
EC2-Classic: You can have up to 100 rules per group.
EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.
[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.
" - }, - "BundleInstance":{ - "name":"BundleInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BundleInstanceRequest"}, - "output":{"shape":"BundleInstanceResult"}, - "documentation":"Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.
For more information, see Creating an Instance Store-Backed Windows AMI.
" - }, - "CancelBundleTask":{ - "name":"CancelBundleTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelBundleTaskRequest"}, - "output":{"shape":"CancelBundleTaskResult"}, - "documentation":"Cancels a bundling operation for an instance store-backed Windows instance.
" - }, - "CancelConversionTask":{ - "name":"CancelConversionTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelConversionRequest"}, - "documentation":"Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CancelExportTask":{ - "name":"CancelExportTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelExportTaskRequest"}, - "documentation":"Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
" - }, - "CancelReservedInstancesListing":{ - "name":"CancelReservedInstancesListing", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelReservedInstancesListingRequest"}, - "output":{"shape":"CancelReservedInstancesListingResult"}, - "documentation":"Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CancelSpotInstanceRequests":{ - "name":"CancelSpotInstanceRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelSpotInstanceRequestsRequest"}, - "output":{"shape":"CancelSpotInstanceRequestsResult"}, - "documentation":"Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.
" - }, - "CopyImage":{ - "name":"CopyImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CopyImageRequest"}, - "output":{"shape":"CopyImageResult"}, - "documentation":"Initiates the copy of an AMI from the specified source region to the region in which the request was made. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.
For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CopySnapshot":{ - "name":"CopySnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CopySnapshotRequest"}, - "output":{"shape":"CopySnapshotResult"}, - "documentation":"Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.
Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.
For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateCustomerGateway":{ - "name":"CreateCustomerGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCustomerGatewayRequest"}, - "output":{"shape":"CreateCustomerGatewayResult"}, - "documentation":"Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateDhcpOptions":{ - "name":"CreateDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDhcpOptionsRequest"}, - "output":{"shape":"CreateDhcpOptionsResult"}, - "documentation":"Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). If specifying more than one domain name, separate them with spaces.ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.netbios-name-servers - The IP addresses of up to four NetBIOS name servers.netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132. Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateInstanceExportTask":{ - "name":"CreateInstanceExportTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInstanceExportTaskRequest"}, - "output":{"shape":"CreateInstanceExportTaskResult"}, - "documentation":"Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateInternetGateway":{ - "name":"CreateInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInternetGatewayRequest"}, - "output":{"shape":"CreateInternetGatewayResult"}, - "documentation":"Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateKeyPair":{ - "name":"CreateKeyPair", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateKeyPairRequest"}, - "output":{ - "shape":"KeyPair", - "documentation":"Information about the key pair.
", - "locationName":"keyPair" - }, - "documentation":"Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per region.
The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateNetworkAcl":{ - "name":"CreateNetworkAcl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkAclRequest"}, - "output":{"shape":"CreateNetworkAclResult"}, - "documentation":"Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateNetworkAclEntry":{ - "name":"CreateNetworkAclEntry", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkAclEntryRequest"}, - "documentation":"Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateNetworkInterface":{ - "name":"CreateNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkInterfaceRequest"}, - "output":{"shape":"CreateNetworkInterfaceResult"}, - "documentation":"Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreatePlacementGroup":{ - "name":"CreatePlacementGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePlacementGroupRequest"}, - "documentation":"Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.
For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateReservedInstancesListing":{ - "name":"CreateReservedInstancesListing", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateReservedInstancesListingRequest"}, - "output":{"shape":"CreateReservedInstancesListingResult"}, - "documentation":"Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateRoute":{ - "name":"CreateRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRouteRequest"}, - "documentation":"Creates a route in a route table within a VPC.
You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.
When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateRouteTable":{ - "name":"CreateRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRouteTableRequest"}, - "output":{"shape":"CreateRouteTableResult"}, - "documentation":"Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateSecurityGroup":{ - "name":"CreateSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSecurityGroupRequest"}, - "output":{"shape":"CreateSecurityGroupResult"}, - "documentation":"Creates a security group.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
EC2-Classic: You can have up to 500 security groups.
EC2-VPC: You can create up to 100 security groups per VPC.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
" - }, - "CreateSnapshot":{ - "name":"CreateSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSnapshotRequest"}, - "output":{ - "shape":"Snapshot", - "locationName":"snapshot" - }, - "documentation":"Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateSpotDatafeedSubscription":{ - "name":"CreateSpotDatafeedSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, - "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, - "documentation":"Creates a datafeed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateSubnet":{ - "name":"CreateSubnet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSubnetRequest"}, - "output":{"shape":"CreateSubnetResult"}, - "documentation":"Creates a subnet in an existing VPC.
When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).
AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateTags":{ - "name":"CreateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTagsRequest"}, - "documentation":"Adds or overwrites one or more tags for the specified EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateVolume":{ - "name":"CreateVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVolumeRequest"}, - "output":{ - "shape":"Volume", - "locationName":"volume" - }, - "documentation":"Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.
You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
" - }, - "CreateVpc":{ - "name":"CreateVpc", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpcRequest"}, - "output":{"shape":"CreateVpcResult"}, - "documentation":"Creates a VPC with the specified CIDR block.
The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateVpcPeeringConnection":{ - "name":"CreateVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpcPeeringConnectionRequest"}, - "output":{"shape":"CreateVpcPeeringConnectionResult"}, - "documentation":"Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.
The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateVpnConnectionRoute":{ - "name":"CreateVpnConnectionRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpnConnectionRouteRequest"}, - "documentation":"Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateVpnGateway":{ - "name":"CreateVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpnGatewayRequest"}, - "output":{"shape":"CreateVpnGatewayResult"}, - "documentation":"Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DeleteCustomerGateway":{ - "name":"DeleteCustomerGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteCustomerGatewayRequest"}, - "documentation":"Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
" - }, - "DeleteDhcpOptions":{ - "name":"DeleteDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDhcpOptionsRequest"}, - "documentation":"Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
" - }, - "DeleteInternetGateway":{ - "name":"DeleteInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInternetGatewayRequest"}, - "documentation":"Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.
" - }, - "DeleteKeyPair":{ - "name":"DeleteKeyPair", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteKeyPairRequest"}, - "documentation":"Deletes the specified key pair, by removing the public key from Amazon EC2.
" - }, - "DeleteNetworkAcl":{ - "name":"DeleteNetworkAcl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkAclRequest"}, - "documentation":"Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
" - }, - "DeleteNetworkAclEntry":{ - "name":"DeleteNetworkAclEntry", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkAclEntryRequest"}, - "documentation":"Deletes the specified ingress or egress entry (rule) from the specified network ACL.
" - }, - "DeleteNetworkInterface":{ - "name":"DeleteNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkInterfaceRequest"}, - "documentation":"Deletes the specified network interface. You must detach the network interface before you can delete it.
" - }, - "DeletePlacementGroup":{ - "name":"DeletePlacementGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePlacementGroupRequest"}, - "documentation":"Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DeleteRoute":{ - "name":"DeleteRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRouteRequest"}, - "documentation":"Deletes the specified route from the specified route table.
" - }, - "DeleteRouteTable":{ - "name":"DeleteRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRouteTableRequest"}, - "documentation":"Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
" - }, - "DeleteSecurityGroup":{ - "name":"DeleteSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSecurityGroupRequest"}, - "documentation":"Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DeleteSpotDatafeedSubscription":{ - "name":"DeleteSpotDatafeedSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, - "documentation":"Deletes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DeleteSubnet":{ - "name":"DeleteSubnet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSubnetRequest"}, - "documentation":"Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
" - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTagsRequest"}, - "documentation":"Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DeleteVolume":{ - "name":"DeleteVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVolumeRequest"}, - "documentation":"Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).
For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DeleteVpc":{ - "name":"DeleteVpc", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpcRequest"}, - "documentation":"Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
" - }, - "DeleteVpcPeeringConnection":{ - "name":"DeleteVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, - "output":{"shape":"DeleteVpcPeeringConnectionResult"}, - "documentation":"Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.
" - }, - "DeleteVpnConnectionRoute":{ - "name":"DeleteVpnConnectionRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpnConnectionRouteRequest"}, - "documentation":"Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
" - }, - "DeleteVpnGateway":{ - "name":"DeleteVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpnGatewayRequest"}, - "documentation":"Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
" - }, - "DeregisterImage":{ - "name":"DeregisterImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterImageRequest"}, - "documentation":"Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
This command does not delete the AMI.
" - }, - "DescribeAccountAttributes":{ - "name":"DescribeAccountAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAccountAttributesRequest"}, - "output":{"shape":"DescribeAccountAttributesResult"}, - "documentation":"Describes the specified attribute of your AWS account.
" - }, - "DescribeAddresses":{ - "name":"DescribeAddresses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAddressesRequest"}, - "output":{"shape":"DescribeAddressesResult"}, - "documentation":"Describes one or more of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeAvailabilityZones":{ - "name":"DescribeAvailabilityZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAvailabilityZonesRequest"}, - "output":{"shape":"DescribeAvailabilityZonesResult"}, - "documentation":"Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeBundleTasks":{ - "name":"DescribeBundleTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeBundleTasksRequest"}, - "output":{"shape":"DescribeBundleTasksResult"}, - "documentation":"Describes one or more of your bundling tasks.
" - }, - "DescribeConversionTasks":{ - "name":"DescribeConversionTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeConversionTasksRequest"}, - "output":{"shape":"DescribeConversionTasksResult"}, - "documentation":"Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeCustomerGateways":{ - "name":"DescribeCustomerGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCustomerGatewaysRequest"}, - "output":{"shape":"DescribeCustomerGatewaysResult"}, - "documentation":"Describes one or more of your VPN customer gateways.
For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeDhcpOptions":{ - "name":"DescribeDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDhcpOptionsRequest"}, - "output":{"shape":"DescribeDhcpOptionsResult"}, - "documentation":"Describes one or more of your DHCP options sets.
For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeExportTasks":{ - "name":"DescribeExportTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeExportTasksRequest"}, - "output":{"shape":"DescribeExportTasksResult"}, - "documentation":"Describes one or more of your export tasks.
" - }, - "DescribeImageAttribute":{ - "name":"DescribeImageAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImageAttributeRequest"}, - "output":{ - "shape":"ImageAttribute", - "documentation":"Information about the image attribute.
", - "locationName":"imageAttribute" - }, - "documentation":"Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
" - }, - "DescribeImages":{ - "name":"DescribeImages", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImagesRequest"}, - "output":{"shape":"DescribeImagesResult"}, - "documentation":"Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
" - }, - "DescribeInstanceAttribute":{ - "name":"DescribeInstanceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInstanceAttributeRequest"}, - "output":{"shape":"InstanceAttribute"}, - "documentation":"Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
Describes the status of one or more instances, including any scheduled events.
Instance status has two main components:
System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.
Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.
Instance status provides information about four types of scheduled events for an instance that may require your attention:
Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.
System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.
Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.
Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.
When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.
For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeInstances":{ - "name":"DescribeInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInstancesRequest"}, - "output":{"shape":"DescribeInstancesResult"}, - "documentation":"Describes one or more of your instances.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
" - }, - "DescribeInternetGateways":{ - "name":"DescribeInternetGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInternetGatewaysRequest"}, - "output":{"shape":"DescribeInternetGatewaysResult"}, - "documentation":"Describes one or more of your Internet gateways.
" - }, - "DescribeKeyPairs":{ - "name":"DescribeKeyPairs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeKeyPairsRequest"}, - "output":{"shape":"DescribeKeyPairsResult"}, - "documentation":"Describes one or more of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeNetworkAcls":{ - "name":"DescribeNetworkAcls", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNetworkAclsRequest"}, - "output":{"shape":"DescribeNetworkAclsResult"}, - "documentation":"Describes one or more of your network ACLs.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeNetworkInterfaceAttribute":{ - "name":"DescribeNetworkInterfaceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, - "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, - "documentation":"Describes a network interface attribute. You can specify only one attribute at a time.
" - }, - "DescribeNetworkInterfaces":{ - "name":"DescribeNetworkInterfaces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNetworkInterfacesRequest"}, - "output":{"shape":"DescribeNetworkInterfacesResult"}, - "documentation":"Describes one or more of your network interfaces.
" - }, - "DescribePlacementGroups":{ - "name":"DescribePlacementGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePlacementGroupsRequest"}, - "output":{"shape":"DescribePlacementGroupsResult"}, - "documentation":"Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeRegions":{ - "name":"DescribeRegions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRegionsRequest"}, - "output":{"shape":"DescribeRegionsResult"}, - "documentation":"Describes one or more regions that are currently available to you.
For a list of the regions supported by Amazon EC2, see Regions and Endpoints.
" - }, - "DescribeReservedInstances":{ - "name":"DescribeReservedInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesRequest"}, - "output":{"shape":"DescribeReservedInstancesResult"}, - "documentation":"Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeReservedInstancesListings":{ - "name":"DescribeReservedInstancesListings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesListingsRequest"}, - "output":{"shape":"DescribeReservedInstancesListingsResult"}, - "documentation":"Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeReservedInstancesModifications":{ - "name":"DescribeReservedInstancesModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, - "output":{"shape":"DescribeReservedInstancesModificationsResult"}, - "documentation":"Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeReservedInstancesOfferings":{ - "name":"DescribeReservedInstancesOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, - "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, - "documentation":"Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeRouteTables":{ - "name":"DescribeRouteTables", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRouteTablesRequest"}, - "output":{"shape":"DescribeRouteTablesResult"}, - "documentation":"Describes one or more of your route tables.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeSecurityGroups":{ - "name":"DescribeSecurityGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSecurityGroupsRequest"}, - "output":{"shape":"DescribeSecurityGroupsResult"}, - "documentation":"Describes one or more of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeSnapshotAttribute":{ - "name":"DescribeSnapshotAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSnapshotAttributeRequest"}, - "output":{"shape":"DescribeSnapshotAttributeResult"}, - "documentation":"Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeSnapshots":{ - "name":"DescribeSnapshots", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSnapshotsRequest"}, - "output":{"shape":"DescribeSnapshotsResult"}, - "documentation":"Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
The create volume permissions fall into the following categories:
all group. All AWS accounts have create volume permissions for these snapshots.The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeSpotDatafeedSubscription":{ - "name":"DescribeSpotDatafeedSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, - "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, - "documentation":"Describes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeSpotInstanceRequests":{ - "name":"DescribeSpotInstanceRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, - "output":{"shape":"DescribeSpotInstanceRequestsResult"}, - "documentation":"Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
Describes the Spot Price history. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
When you specify an Availability Zone, this operation describes the price history for the specified Availability Zone with the most recent set of prices listed first. If you don't specify an Availability Zone, you get the prices across all Availability Zones, starting with the most recent set. However, if you're using an API version earlier than 2011-05-15, you get the lowest price across the region for the specified time period. The prices returned are listed in chronological order, from the oldest to the most recent.
When you specify the start and end time options, this operation returns two pieces of data: the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
" - }, - "DescribeSubnets":{ - "name":"DescribeSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSubnetsRequest"}, - "output":{"shape":"DescribeSubnetsResult"}, - "documentation":"Describes one or more of your subnets.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeTags":{ - "name":"DescribeTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTagsRequest"}, - "output":{"shape":"DescribeTagsResult"}, - "documentation":"Describes one or more of the tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeVolumeAttribute":{ - "name":"DescribeVolumeAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVolumeAttributeRequest"}, - "output":{"shape":"DescribeVolumeAttributeResult"}, - "documentation":"Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeVolumeStatus":{ - "name":"DescribeVolumeStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVolumeStatusRequest"}, - "output":{"shape":"DescribeVolumeStatusResult"}, - "documentation":"Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.
Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.
Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Describes the specified Amazon EBS volumes.
If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DescribeVpcAttribute":{ - "name":"DescribeVpcAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcAttributeRequest"}, - "output":{"shape":"DescribeVpcAttributeResult"}, - "documentation":"Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
" - }, - "DescribeVpcPeeringConnections":{ - "name":"DescribeVpcPeeringConnections", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, - "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, - "documentation":"Describes one or more of your VPC peering connections.
" - }, - "DescribeVpcs":{ - "name":"DescribeVpcs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcsRequest"}, - "output":{"shape":"DescribeVpcsResult"}, - "documentation":"Describes one or more of your VPCs.
" - }, - "DescribeVpnConnections":{ - "name":"DescribeVpnConnections", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpnConnectionsRequest"}, - "output":{"shape":"DescribeVpnConnectionsResult"}, - "documentation":"Describes one or more of your VPN connections.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeVpnGateways":{ - "name":"DescribeVpnGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpnGatewaysRequest"}, - "output":{"shape":"DescribeVpnGatewaysResult"}, - "documentation":"Describes one or more of your virtual private gateways.
For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DetachInternetGateway":{ - "name":"DetachInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachInternetGatewayRequest"}, - "documentation":"Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.
" - }, - "DetachNetworkInterface":{ - "name":"DetachNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachNetworkInterfaceRequest"}, - "documentation":"Detaches a network interface from an instance.
" - }, - "DetachVolume":{ - "name":"DetachVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachVolumeRequest"}, - "output":{ - "shape":"VolumeAttachment", - "locationName":"attachment" - }, - "documentation":"Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.
If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no longer associated with the instance.
For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
" - }, - "DetachVpnGateway":{ - "name":"DetachVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachVpnGatewayRequest"}, - "documentation":"Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
" - }, - "DisassociateAddress":{ - "name":"DisassociateAddress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateAddressRequest"}, - "documentation":"Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" - }, - "DisassociateRouteTable":{ - "name":"DisassociateRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateRouteTableRequest"}, - "documentation":"Disassociates a subnet from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "EnableVgwRoutePropagation":{ - "name":"EnableVgwRoutePropagation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableVgwRoutePropagationRequest"}, - "documentation":"Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
" - }, - "EnableVolumeIO":{ - "name":"EnableVolumeIO", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableVolumeIORequest"}, - "documentation":"Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
" - }, - "GetConsoleOutput":{ - "name":"GetConsoleOutput", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetConsoleOutputRequest"}, - "output":{"shape":"GetConsoleOutputResult"}, - "documentation":"Gets the console output for the specified instance.
Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.
Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.
For Linux/Unix instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a machine. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.
For Windows instances, the instance console output displays the last three system event log errors.
" - }, - "GetPasswordData":{ - "name":"GetPasswordData", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPasswordDataRequest"}, - "output":{"shape":"GetPasswordDataResult"}, - "documentation":"Retrieves the encrypted administrator password for an instance running Windows.
The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
" - }, - "ImportInstance":{ - "name":"ImportInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportInstanceRequest"}, - "output":{"shape":"ImportInstanceResult"}, - "documentation":"Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
" - }, - "ImportVolume":{ - "name":"ImportVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportVolumeRequest"}, - "output":{"shape":"ImportVolumeResult"}, - "documentation":"Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
" - }, - "ModifyInstanceAttribute":{ - "name":"ModifyInstanceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyInstanceAttributeRequest"}, - "documentation":"Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.
" - }, - "ModifyNetworkInterfaceAttribute":{ - "name":"ModifyNetworkInterfaceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, - "documentation":"Modifies the specified network interface attribute. You can specify only one attribute at a time.
" - }, - "ModifyReservedInstances":{ - "name":"ModifyReservedInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyReservedInstancesRequest"}, - "output":{"shape":"ModifyReservedInstancesResult"}, - "documentation":"Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "ModifySnapshotAttribute":{ - "name":"ModifySnapshotAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifySnapshotAttributeRequest"}, - "documentation":"Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
" - }, - "ModifySubnetAttribute":{ - "name":"ModifySubnetAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifySubnetAttributeRequest"}, - "documentation":"Modifies a subnet attribute.
" - }, - "ModifyVolumeAttribute":{ - "name":"ModifyVolumeAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyVolumeAttributeRequest"}, - "documentation":"Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
" - }, - "ModifyVpcAttribute":{ - "name":"ModifyVpcAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyVpcAttributeRequest"}, - "documentation":"Modifies the specified attribute of the specified VPC.
" - }, - "MonitorInstances":{ - "name":"MonitorInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"MonitorInstancesRequest"}, - "output":{"shape":"MonitorInstancesResult"}, - "documentation":"Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
" - }, - "PurchaseReservedInstancesOffering":{ - "name":"PurchaseReservedInstancesOffering", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, - "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, - "documentation":"Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" - }, - "RebootInstances":{ - "name":"RebootInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RebootInstancesRequest"}, - "documentation":"Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "RegisterImage":{ - "name":"RegisterImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterImageRequest"}, - "output":{"shape":"RegisterImageResult"}, - "documentation":"Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
" - }, - "RejectVpcPeeringConnection":{ - "name":"RejectVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RejectVpcPeeringConnectionRequest"}, - "output":{"shape":"RejectVpcPeeringConnectionResult"}, - "documentation":"Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.
Releases the specified Elastic IP address.
After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "ReplaceNetworkAclEntry":{ - "name":"ReplaceNetworkAclEntry", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReplaceNetworkAclEntryRequest"}, - "documentation":"Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "ReplaceRoute":{ - "name":"ReplaceRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReplaceRouteRequest"}, - "documentation":"Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "ReplaceRouteTableAssociation":{ - "name":"ReplaceRouteTableAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReplaceRouteTableAssociationRequest"}, - "output":{"shape":"ReplaceRouteTableAssociationResult"}, - "documentation":"Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.
" - }, - "ReportInstanceStatus":{ - "name":"ReportInstanceStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReportInstanceStatusRequest"}, - "documentation":"Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
" - }, - "RequestSpotInstances":{ - "name":"RequestSpotInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RequestSpotInstancesRequest"}, - "output":{"shape":"RequestSpotInstancesResult"}, - "documentation":"Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
Users must be subscribed to the required product to run an instance with AWS Marketplace product codes.
" - }, - "ResetImageAttribute":{ - "name":"ResetImageAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetImageAttributeRequest"}, - "documentation":"Resets an attribute of an AMI to its default value.
" - }, - "ResetInstanceAttribute":{ - "name":"ResetInstanceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetInstanceAttributeRequest"}, - "documentation":"Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.
The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
Resets a network interface attribute. You can specify only one attribute at a time.
" - }, - "ResetSnapshotAttribute":{ - "name":"ResetSnapshotAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetSnapshotAttributeRequest"}, - "documentation":"Resets permission settings for the specified snapshot.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
" - }, - "RevokeSecurityGroupEgress":{ - "name":"RevokeSecurityGroupEgress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RevokeSecurityGroupEgressRequest"}, - "documentation":"Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.
Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
" - }, - "RevokeSecurityGroupIngress":{ - "name":"RevokeSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RevokeSecurityGroupIngressRequest"}, - "documentation":"Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.
Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
" - }, - "RunInstances":{ - "name":"RunInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RunInstancesRequest"}, - "output":{ - "shape":"Reservation", - "documentation":"One or more reservations.
", - "locationName":"reservation" - }, - "documentation":"Launches the specified number of instances using an AMI for which you have permissions.
When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.
If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.
If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.
T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.
For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
" - }, - "StartInstances":{ - "name":"StartInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartInstancesRequest"}, - "output":{"shape":"StartInstancesResult"}, - "documentation":"Starts an Amazon EBS-backed AMI that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "StopInstances":{ - "name":"StopInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInstancesRequest"}, - "output":{"shape":"StopInstancesResult"}, - "documentation":"Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.
You can't start or stop Spot Instances.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.
" - }, - "TerminateInstances":{ - "name":"TerminateInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TerminateInstancesRequest"}, - "output":{"shape":"TerminateInstancesResult"}, - "documentation":"Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.
" - }, - "UnassignPrivateIpAddresses":{ - "name":"UnassignPrivateIpAddresses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UnassignPrivateIpAddressesRequest"}, - "documentation":"Unassigns one or more secondary private IP addresses from a network interface.
" - }, - "UnmonitorInstances":{ - "name":"UnmonitorInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UnmonitorInstancesRequest"}, - "output":{"shape":"UnmonitorInstancesResult"}, - "documentation":"Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
" - } - }, - "shapes":{ - "AcceptVpcPeeringConnectionRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "AcceptVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "VpcPeeringConnection":{ - "shape":"VpcPeeringConnection", - "documentation":"Information about the VPC peering connection.
", - "locationName":"vpcPeeringConnection" - } - } - }, - "AccountAttribute":{ - "type":"structure", - "members":{ - "AttributeName":{ - "shape":"String", - "documentation":"The name of the account attribute.
", - "locationName":"attributeName" - }, - "AttributeValues":{ - "shape":"AccountAttributeValueList", - "documentation":"One or more values for the account attribute.
", - "locationName":"attributeValueSet" - } - }, - "documentation":"Describes an account attribute.
" - }, - "AccountAttributeList":{ - "type":"list", - "member":{ - "shape":"AccountAttribute", - "locationName":"item" - } - }, - "AccountAttributeName":{ - "type":"string", - "enum":[ - "supported-platforms", - "default-vpc" - ] - }, - "AccountAttributeNameStringList":{ - "type":"list", - "member":{ - "shape":"AccountAttributeName", - "locationName":"attributeName" - } - }, - "AccountAttributeValue":{ - "type":"structure", - "members":{ - "AttributeValue":{ - "shape":"String", - "documentation":"The value of the attribute.
", - "locationName":"attributeValue" - } - }, - "documentation":"Describes a value of an account attribute.
" - }, - "AccountAttributeValueList":{ - "type":"list", - "member":{ - "shape":"AccountAttributeValue", - "locationName":"item" - } - }, - "Address":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance the address is associated with (if any).
", - "locationName":"instanceId" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
", - "locationName":"publicIp" - }, - "AllocationId":{ - "shape":"String", - "documentation":"The ID representing the allocation of the address for use with EC2-VPC.
", - "locationName":"allocationId" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The ID representing the association of the address with an instance in a VPC.
", - "locationName":"associationId" - }, - "Domain":{ - "shape":"DomainType", - "documentation":"Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "NetworkInterfaceOwnerId":{ - "shape":"String", - "documentation":"The ID of the AWS account that owns the network interface.
", - "locationName":"networkInterfaceOwnerId" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address associated with the Elastic IP address.
", - "locationName":"privateIpAddress" - } - }, - "documentation":"Describes an Elastic IP address.
" - }, - "AddressList":{ - "type":"list", - "member":{ - "shape":"Address", - "locationName":"item" - } - }, - "AllocateAddressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Domain":{ - "shape":"DomainType", - "documentation":"Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
" - } - } - }, - "AllocateAddressResult":{ - "type":"structure", - "members":{ - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
", - "locationName":"publicIp" - }, - "Domain":{ - "shape":"DomainType", - "documentation":"Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
", - "locationName":"allocationId" - } - } - }, - "AllocationIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"AllocationId" - } - }, - "ArchitectureValues":{ - "type":"string", - "enum":[ - "i386", - "x86_64" - ] - }, - "AssignPrivateIpAddressesRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "PrivateIpAddresses":{ - "shape":"PrivateIpAddressStringList", - "documentation":"One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", - "locationName":"privateIpAddress" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
", - "locationName":"secondaryPrivateIpAddressCount" - }, - "AllowReassignment":{ - "shape":"Boolean", - "documentation":"Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
", - "locationName":"allowReassignment" - } - } - }, - "AssociateAddressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address. This is required for EC2-Classic.
" - }, - "AllocationId":{ - "shape":"String", - "documentation":"[EC2-VPC] The allocation ID. This is required for EC2-VPC.
" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
", - "locationName":"networkInterfaceId" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", - "locationName":"privateIpAddress" - }, - "AllowReassociation":{ - "shape":"Boolean", - "documentation":"[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.
Default: false
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
", - "locationName":"associationId" - } - } - }, - "AssociateDhcpOptionsRequest":{ - "type":"structure", - "required":[ - "DhcpOptionsId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
The ID of the VPC.
" - } - } - }, - "AssociateRouteTableRequest":{ - "type":"structure", - "required":[ - "SubnetId", - "RouteTableId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - } - } - }, - "AssociateRouteTableResult":{ - "type":"structure", - "members":{ - "AssociationId":{ - "shape":"String", - "documentation":"The route table association ID (needed to disassociate the route table).
", - "locationName":"associationId" - } - } - }, - "AttachInternetGatewayRequest":{ - "type":"structure", - "required":[ - "InternetGatewayId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InternetGatewayId":{ - "shape":"String", - "documentation":"The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "AttachNetworkInterfaceRequest":{ - "type":"structure", - "required":[ - "NetworkInterfaceId", - "InstanceId", - "DeviceIndex" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The index of the device for the network interface attachment.
", - "locationName":"deviceIndex" - } - } - }, - "AttachNetworkInterfaceResult":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - } - } - }, - "AttachVolumeRequest":{ - "type":"structure", - "required":[ - "VolumeId", - "InstanceId", - "Device" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - }, - "Device":{ - "shape":"String", - "documentation":"The device name to expose to the instance (for example, /dev/sdh or xvdh).
The ID of the virtual private gateway.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
" - } - } - }, - "AttachVpnGatewayResult":{ - "type":"structure", - "members":{ - "VpcAttachment":{ - "shape":"VpcAttachment", - "documentation":"Information about the attachment.
", - "locationName":"attachment" - } - } - }, - "AttachmentStatus":{ - "type":"string", - "enum":[ - "attaching", - "attached", - "detaching", - "detached" - ] - }, - "AttributeBooleanValue":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"Boolean", - "locationName":"value" - } - } - }, - "AttributeValue":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"String", - "locationName":"value" - } - } - }, - "AuthorizeSecurityGroupEgressRequest":{ - "type":"structure", - "required":["GroupId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupName" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupOwnerId" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
", - "locationName":"cidrIp" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"ipPermissions" - } - } - }, - "AuthorizeSecurityGroupIngressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the security group.
" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
" - } - } - }, - "AvailabilityZone":{ - "type":"structure", - "members":{ - "ZoneName":{ - "shape":"String", - "documentation":"The name of the Availability Zone.
", - "locationName":"zoneName" - }, - "State":{ - "shape":"AvailabilityZoneState", - "documentation":"The state of the Availability Zone (available | impaired | unavailable).
The name of the region.
", - "locationName":"regionName" - }, - "Messages":{ - "shape":"AvailabilityZoneMessageList", - "documentation":"Any messages about the Availability Zone.
", - "locationName":"messageSet" - } - }, - "documentation":"Describes an Availability Zone.
" - }, - "AvailabilityZoneList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZone", - "locationName":"item" - } - }, - "AvailabilityZoneMessage":{ - "type":"structure", - "members":{ - "Message":{ - "shape":"String", - "documentation":"The message about the Availability Zone.
", - "locationName":"message" - } - }, - "documentation":"Describes a message about an Availability Zone.
" - }, - "AvailabilityZoneMessageList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZoneMessage", - "locationName":"item" - } - }, - "AvailabilityZoneState":{ - "type":"string", - "enum":["available"] - }, - "BlockDeviceMapping":{ - "type":"structure", - "members":{ - "VirtualName":{ - "shape":"String", - "documentation":"The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
", - "locationName":"virtualName" - }, - "DeviceName":{ - "shape":"String", - "documentation":"The device name exposed to the instance (for example, /dev/sdh).
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
", - "locationName":"ebs" - }, - "NoDevice":{ - "shape":"String", - "documentation":"Suppresses the specified device included in the block device mapping of the AMI.
", - "locationName":"noDevice" - } - }, - "documentation":"Describes a block device mapping.
" - }, - "BlockDeviceMappingList":{ - "type":"list", - "member":{ - "shape":"BlockDeviceMapping", - "locationName":"item" - } - }, - "BlockDeviceMappingRequestList":{ - "type":"list", - "member":{ - "shape":"BlockDeviceMapping", - "locationName":"BlockDeviceMapping" - } - }, - "Boolean":{"type":"boolean"}, - "BundleIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"BundleId" - } - }, - "BundleInstanceRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Storage" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance to bundle.
" - }, - "Storage":{ - "shape":"Storage", - "documentation":"The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
" - } - } - }, - "BundleInstanceResult":{ - "type":"structure", - "members":{ - "BundleTask":{ - "shape":"BundleTask", - "documentation":"Information about the bundle task.
", - "locationName":"bundleInstanceTask" - } - } - }, - "BundleTask":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance associated with this bundle task.
", - "locationName":"instanceId" - }, - "BundleId":{ - "shape":"String", - "documentation":"The ID for this bundle task.
", - "locationName":"bundleId" - }, - "State":{ - "shape":"BundleTaskState", - "documentation":"The state of the task.
", - "locationName":"state" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time this task started.
", - "locationName":"startTime" - }, - "UpdateTime":{ - "shape":"DateTime", - "documentation":"The time of the most recent update for the task.
", - "locationName":"updateTime" - }, - "Storage":{ - "shape":"Storage", - "documentation":"The Amazon S3 storage locations.
", - "locationName":"storage" - }, - "Progress":{ - "shape":"String", - "documentation":"The level of task completion, as a percent (for example, 20%).
", - "locationName":"progress" - }, - "BundleTaskError":{ - "shape":"BundleTaskError", - "documentation":"If the task fails, a description of the error.
", - "locationName":"error" - } - }, - "documentation":"Describes a bundle task.
" - }, - "BundleTaskError":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The error code.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"The error message.
", - "locationName":"message" - } - }, - "documentation":"Describes an error for BundleInstance.
" - }, - "BundleTaskList":{ - "type":"list", - "member":{ - "shape":"BundleTask", - "locationName":"item" - } - }, - "BundleTaskState":{ - "type":"string", - "enum":[ - "pending", - "waiting-for-shutdown", - "bundling", - "storing", - "cancelling", - "complete", - "failed" - ] - }, - "CancelBundleTaskRequest":{ - "type":"structure", - "required":["BundleId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "BundleId":{ - "shape":"String", - "documentation":"The ID of the bundle task.
" - } - } - }, - "CancelBundleTaskResult":{ - "type":"structure", - "members":{ - "BundleTask":{ - "shape":"BundleTask", - "documentation":"The bundle task.
", - "locationName":"bundleInstanceTask" - } - } - }, - "CancelConversionRequest":{ - "type":"structure", - "required":["ConversionTaskId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ConversionTaskId":{ - "shape":"String", - "documentation":"The ID of the conversion task.
", - "locationName":"conversionTaskId" - }, - "ReasonMessage":{ - "shape":"String", - "locationName":"reasonMessage" - } - } - }, - "CancelExportTaskRequest":{ - "type":"structure", - "required":["ExportTaskId"], - "members":{ - "ExportTaskId":{ - "shape":"String", - "documentation":"The ID of the export task. This is the ID returned by CreateInstanceExportTask.
The ID of the Reserved Instance listing.
", - "locationName":"reservedInstancesListingId" - } - } - }, - "CancelReservedInstancesListingResult":{ - "type":"structure", - "members":{ - "ReservedInstancesListings":{ - "shape":"ReservedInstancesListingList", - "documentation":"The Reserved Instance listing.
", - "locationName":"reservedInstancesListingsSet" - } - } - }, - "CancelSpotInstanceRequestState":{ - "type":"string", - "enum":[ - "active", - "open", - "closed", - "cancelled", - "completed" - ] - }, - "CancelSpotInstanceRequestsRequest":{ - "type":"structure", - "required":["SpotInstanceRequestIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SpotInstanceRequestIds":{ - "shape":"SpotInstanceRequestIdList", - "documentation":"One or more Spot Instance request IDs.
", - "locationName":"SpotInstanceRequestId" - } - } - }, - "CancelSpotInstanceRequestsResult":{ - "type":"structure", - "members":{ - "CancelledSpotInstanceRequests":{ - "shape":"CancelledSpotInstanceRequestList", - "documentation":"One or more Spot Instance requests.
", - "locationName":"spotInstanceRequestSet" - } - } - }, - "CancelledSpotInstanceRequest":{ - "type":"structure", - "members":{ - "SpotInstanceRequestId":{ - "shape":"String", - "documentation":"The ID of the Spot Instance request.
", - "locationName":"spotInstanceRequestId" - }, - "State":{ - "shape":"CancelSpotInstanceRequestState", - "documentation":"The state of the Spot Instance request.
", - "locationName":"state" - } - }, - "documentation":"Describes a request to cancel a Spot Instance.
" - }, - "CancelledSpotInstanceRequestList":{ - "type":"list", - "member":{ - "shape":"CancelledSpotInstanceRequest", - "locationName":"item" - } - }, - "ConfirmProductInstanceRequest":{ - "type":"structure", - "required":[ - "ProductCode", - "InstanceId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ProductCode":{ - "shape":"String", - "documentation":"The product code. This must be a product code that you own.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - } - } - }, - "ConfirmProductInstanceResult":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.
", - "locationName":"ownerId" - } - } - }, - "ContainerFormat":{ - "type":"string", - "enum":["ova"] - }, - "ConversionIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"item" - } - }, - "ConversionTask":{ - "type":"structure", - "required":[ - "ConversionTaskId", - "State" - ], - "members":{ - "ConversionTaskId":{ - "shape":"String", - "documentation":"The ID of the conversion task.
", - "locationName":"conversionTaskId" - }, - "ExpirationTime":{ - "shape":"String", - "documentation":"The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
", - "locationName":"expirationTime" - }, - "ImportInstance":{ - "shape":"ImportInstanceTaskDetails", - "documentation":"If the task is for importing an instance, this contains information about the import instance task.
", - "locationName":"importInstance" - }, - "ImportVolume":{ - "shape":"ImportVolumeTaskDetails", - "documentation":"If the task is for importing a volume, this contains information about the import volume task.
", - "locationName":"importVolume" - }, - "State":{ - "shape":"ConversionTaskState", - "documentation":"The state of the conversion task.
", - "locationName":"state" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The status message related to the conversion task.
", - "locationName":"statusMessage" - }, - "Tags":{ - "shape":"TagList", - "locationName":"tagSet" - } - }, - "documentation":"Describes a conversion task.
" - }, - "ConversionTaskState":{ - "type":"string", - "enum":[ - "active", - "cancelling", - "cancelled", - "completed" - ] - }, - "CopyImageRequest":{ - "type":"structure", - "required":[ - "SourceRegion", - "SourceImageId", - "Name" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The name of the region that contains the AMI to copy.
" - }, - "SourceImageId":{ - "shape":"String", - "documentation":"The ID of the AMI to copy.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the new AMI in the destination region.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the new AMI in the destination region.
" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
" - } - } - }, - "CopyImageResult":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the new AMI.
", - "locationName":"imageId" - } - } - }, - "CopySnapshotRequest":{ - "type":"structure", - "required":[ - "SourceRegion", - "SourceSnapshotId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The ID of the region that contains the snapshot to be copied.
" - }, - "SourceSnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot to copy.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the new Amazon EBS snapshot.
" - }, - "DestinationRegion":{ - "shape":"String", - "documentation":"The destination region of the snapshot copy operation. This parameter is required in the PresignedUrl.
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
The ID of the new snapshot.
", - "locationName":"snapshotId" - } - } - }, - "CreateCustomerGatewayRequest":{ - "type":"structure", - "required":[ - "Type", - "PublicIp", - "BgpAsn" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection that this customer gateway supports (ipsec.1).
The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
", - "locationName":"IpAddress" - }, - "BgpAsn":{ - "shape":"Integer", - "documentation":"For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
" - } - } - }, - "CreateCustomerGatewayResult":{ - "type":"structure", - "members":{ - "CustomerGateway":{ - "shape":"CustomerGateway", - "documentation":"Information about the customer gateway.
", - "locationName":"customerGateway" - } - } - }, - "CreateDhcpOptionsRequest":{ - "type":"structure", - "required":["DhcpConfigurations"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpConfigurations":{ - "shape":"NewDhcpConfigurationList", - "documentation":"A DHCP configuration option.
", - "locationName":"dhcpConfiguration" - } - } - }, - "CreateDhcpOptionsResult":{ - "type":"structure", - "members":{ - "DhcpOptions":{ - "shape":"DhcpOptions", - "documentation":"A set of DHCP options.
", - "locationName":"dhcpOptions" - } - } - }, - "CreateImageRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Name" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Name":{ - "shape":"String", - "documentation":"A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", - "locationName":"name" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the new image.
", - "locationName":"description" - }, - "NoReboot":{ - "shape":"Boolean", - "documentation":"By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
Information about one or more block device mappings.
", - "locationName":"blockDeviceMapping" - } - } - }, - "CreateImageResult":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the new AMI.
", - "locationName":"imageId" - } - } - }, - "CreateInstanceExportTaskRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "Description":{ - "shape":"String", - "documentation":"A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
", - "locationName":"description" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "TargetEnvironment":{ - "shape":"ExportEnvironment", - "documentation":"The target virtualization environment.
", - "locationName":"targetEnvironment" - }, - "ExportToS3Task":{ - "shape":"ExportToS3TaskSpecification", - "locationName":"exportToS3" - } - } - }, - "CreateInstanceExportTaskResult":{ - "type":"structure", - "members":{ - "ExportTask":{ - "shape":"ExportTask", - "locationName":"exportTask" - } - } - }, - "CreateInternetGatewayRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "CreateInternetGatewayResult":{ - "type":"structure", - "members":{ - "InternetGateway":{ - "shape":"InternetGateway", - "documentation":"Information about the Internet gateway.
", - "locationName":"internetGateway" - } - } - }, - "CreateKeyPairRequest":{ - "type":"structure", - "required":["KeyName"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyName":{ - "shape":"String", - "documentation":"A unique name for the key pair.
Constraints: Up to 255 ASCII characters
" - } - } - }, - "CreateNetworkAclEntryRequest":{ - "type":"structure", - "required":[ - "NetworkAclId", - "RuleNumber", - "Protocol", - "RuleAction", - "Egress", - "CidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766
", - "locationName":"ruleNumber" - }, - "Protocol":{ - "shape":"String", - "documentation":"The protocol. A value of -1 means all protocols.
", - "locationName":"protocol" - }, - "RuleAction":{ - "shape":"RuleAction", - "documentation":"Indicates whether to allow or deny the traffic that matches the rule.
", - "locationName":"ruleAction" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
", - "locationName":"egress" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.
", - "locationName":"Icmp" - }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to.
", - "locationName":"portRange" - } - } - }, - "CreateNetworkAclRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "CreateNetworkAclResult":{ - "type":"structure", - "members":{ - "NetworkAcl":{ - "shape":"NetworkAcl", - "documentation":"Information about the network ACL.
", - "locationName":"networkAcl" - } - } - }, - "CreateNetworkInterfaceRequest":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet to associate with the network interface.
", - "locationName":"subnetId" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the network interface.
", - "locationName":"description" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
The IDs of one or more security groups.
", - "locationName":"SecurityGroupId" - }, - "PrivateIpAddresses":{ - "shape":"PrivateIpAddressSpecificationList", - "documentation":"One or more private IP addresses.
", - "locationName":"privateIpAddresses" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
", - "locationName":"secondaryPrivateIpAddressCount" - }, - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "CreateNetworkInterfaceResult":{ - "type":"structure", - "members":{ - "NetworkInterface":{ - "shape":"NetworkInterface", - "documentation":"Information about the network interface.
", - "locationName":"networkInterface" - } - } - }, - "CreatePlacementGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "Strategy" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"A name for the placement group.
Constraints: Up to 255 ASCII characters
", - "locationName":"groupName" - }, - "Strategy":{ - "shape":"PlacementStrategy", - "documentation":"The placement strategy.
", - "locationName":"strategy" - } - } - }, - "CreateReservedInstancesListingRequest":{ - "type":"structure", - "required":[ - "ReservedInstancesId", - "InstanceCount", - "PriceSchedules", - "ClientToken" - ], - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the active Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
", - "locationName":"instanceCount" - }, - "PriceSchedules":{ - "shape":"PriceScheduleSpecificationList", - "documentation":"A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.
", - "locationName":"priceSchedules" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency in the Amazon Elastic Compute Cloud User Guide.
", - "locationName":"clientToken" - } - } - }, - "CreateReservedInstancesListingResult":{ - "type":"structure", - "members":{ - "ReservedInstancesListings":{ - "shape":"ReservedInstancesListingList", - "documentation":"Information about the Reserved Instances listing.
", - "locationName":"reservedInstancesListingsSet" - } - } - }, - "CreateRouteRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "DestinationCidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table for the route.
", - "locationName":"routeTableId" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
", - "locationName":"destinationCidrBlock" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of an Internet gateway or virtual private gateway attached to your VPC.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
", - "locationName":"instanceId" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of a network interface.
", - "locationName":"networkInterfaceId" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of a VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "CreateRouteTableRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "CreateRouteTableResult":{ - "type":"structure", - "members":{ - "RouteTable":{ - "shape":"RouteTable", - "documentation":"Information about the route table.
", - "locationName":"routeTable" - } - } - }, - "CreateSecurityGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "Description" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", - "locationName":"GroupDescription" - }, - "VpcId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
" - } - } - }, - "CreateSecurityGroupResult":{ - "type":"structure", - "members":{ - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - } - } - }, - "CreateSnapshotRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the snapshot.
" - } - } - }, - "CreateSpotDatafeedSubscriptionRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Bucket":{ - "shape":"String", - "documentation":"The Amazon S3 bucket in which to store the Spot Instance datafeed.
Constraints: Must be a valid bucket associated with your AWS account.
", - "locationName":"bucket" - }, - "Prefix":{ - "shape":"String", - "documentation":"A prefix for the datafeed file names.
", - "locationName":"prefix" - } - } - }, - "CreateSpotDatafeedSubscriptionResult":{ - "type":"structure", - "members":{ - "SpotDatafeedSubscription":{ - "shape":"SpotDatafeedSubscription", - "documentation":"The Spot Instance datafeed subscription.
", - "locationName":"spotDatafeedSubscription" - } - } - }, - "CreateSubnetRequest":{ - "type":"structure", - "required":[ - "VpcId", - "CidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
The Availability Zone for the subnet.
Default: Amazon EC2 selects one for you (recommended).
" - } - } - }, - "CreateSubnetResult":{ - "type":"structure", - "members":{ - "Subnet":{ - "shape":"Subnet", - "documentation":"Information about the subnet.
", - "locationName":"subnet" - } - } - }, - "CreateTagsRequest":{ - "type":"structure", - "required":[ - "Resources", - "Tags" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Resources":{ - "shape":"ResourceIdList", - "documentation":"The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
", - "locationName":"ResourceId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.
", - "locationName":"userId" - }, - "Group":{ - "shape":"PermissionGroup", - "documentation":"The specific group that is to be added or removed from a volume's list of create volume permissions.
", - "locationName":"group" - } - } - }, - "CreateVolumePermissionList":{ - "type":"list", - "member":{ - "shape":"CreateVolumePermission", - "locationName":"item" - } - }, - "CreateVolumePermissionModifications":{ - "type":"structure", - "members":{ - "Add":{ - "shape":"CreateVolumePermissionList", - "documentation":"Adds a specific AWS account ID or group to a volume's list of create volume permissions.
" - }, - "Remove":{ - "shape":"CreateVolumePermissionList", - "documentation":"Removes a specific AWS account ID or group from a volume's list of create volume permissions.
" - } - } - }, - "CreateVolumeRequest":{ - "type":"structure", - "required":["AvailabilityZone"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Size":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiBs.
Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The snapshot from which to create the volume.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
" - }, - "VolumeType":{ - "shape":"VolumeType", - "documentation":"The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
Default: standard
Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume.
" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Specifies whether the volume should be encrypted.
", - "locationName":"encrypted" - } - } - }, - "CreateVpcPeeringConnectionRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the requester VPC.
", - "locationName":"vpcId" - }, - "PeerVpcId":{ - "shape":"String", - "documentation":"The ID of the VPC with which you are creating the VPC peering connection.
", - "locationName":"peerVpcId" - }, - "PeerOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the peer VPC.
Default: Your AWS account ID
", - "locationName":"peerOwnerId" - } - } - }, - "CreateVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "VpcPeeringConnection":{ - "shape":"VpcPeeringConnection", - "documentation":"Information about the VPC peering connection.
", - "locationName":"vpcPeeringConnection" - } - } - }, - "CreateVpcRequest":{ - "type":"structure", - "required":["CidrBlock"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.
Default: default
Information about the VPC.
", - "locationName":"vpc" - } - } - }, - "CreateVpnConnectionRequest":{ - "type":"structure", - "required":[ - "Type", - "CustomerGatewayId", - "VpnGatewayId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Type":{ - "shape":"String", - "documentation":"The type of VPN connection (ipsec.1).
The ID of the customer gateway.
" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - }, - "Options":{ - "shape":"VpnConnectionOptionsSpecification", - "documentation":"Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.
Default: false
Information about the VPN connection.
", - "locationName":"vpnConnection" - } - } - }, - "CreateVpnConnectionRouteRequest":{ - "type":"structure", - "required":[ - "VpnConnectionId", - "DestinationCidrBlock" - ], - "members":{ - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block associated with the local subnet of the customer network.
" - } - } - }, - "CreateVpnGatewayRequest":{ - "type":"structure", - "required":["Type"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection this virtual private gateway supports.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the virtual private gateway.
" - } - } - }, - "CreateVpnGatewayResult":{ - "type":"structure", - "members":{ - "VpnGateway":{ - "shape":"VpnGateway", - "documentation":"Information about the virtual private gateway.
", - "locationName":"vpnGateway" - } - } - }, - "CurrencyCodeValues":{ - "type":"string", - "enum":["USD"] - }, - "CustomerGateway":{ - "type":"structure", - "members":{ - "CustomerGatewayId":{ - "shape":"String", - "documentation":"The ID of the customer gateway.
", - "locationName":"customerGatewayId" - }, - "State":{ - "shape":"String", - "documentation":"The current state of the customer gateway (pending | available | deleting | deleted).
The type of VPN connection the customer gateway supports (ipsec.1).
The Internet-routable IP address of the customer gateway's outside interface.
", - "locationName":"ipAddress" - }, - "BgpAsn":{ - "shape":"String", - "documentation":"The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
", - "locationName":"bgpAsn" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the customer gateway.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a customer gateway.
" - }, - "CustomerGatewayIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"CustomerGatewayId" - } - }, - "CustomerGatewayList":{ - "type":"list", - "member":{ - "shape":"CustomerGateway", - "locationName":"item" - } - }, - "DatafeedSubscriptionState":{ - "type":"string", - "enum":[ - "Active", - "Inactive" - ] - }, - "DateTime":{"type":"timestamp"}, - "DeleteCustomerGatewayRequest":{ - "type":"structure", - "required":["CustomerGatewayId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "CustomerGatewayId":{ - "shape":"String", - "documentation":"The ID of the customer gateway.
" - } - } - }, - "DeleteDhcpOptionsRequest":{ - "type":"structure", - "required":["DhcpOptionsId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the DHCP options set.
" - } - } - }, - "DeleteInternetGatewayRequest":{ - "type":"structure", - "required":["InternetGatewayId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InternetGatewayId":{ - "shape":"String", - "documentation":"The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - } - } - }, - "DeleteKeyPairRequest":{ - "type":"structure", - "required":["KeyName"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
" - } - } - }, - "DeleteNetworkAclEntryRequest":{ - "type":"structure", - "required":[ - "NetworkAclId", - "RuleNumber", - "Egress" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number of the entry to delete.
", - "locationName":"ruleNumber" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether the rule is an egress rule.
", - "locationName":"egress" - } - } - }, - "DeleteNetworkAclRequest":{ - "type":"structure", - "required":["NetworkAclId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - } - } - }, - "DeleteNetworkInterfaceRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - } - } - }, - "DeletePlacementGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group.
", - "locationName":"groupName" - } - } - }, - "DeleteRouteRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "DestinationCidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", - "locationName":"destinationCidrBlock" - } - } - }, - "DeleteRouteTableRequest":{ - "type":"structure", - "required":["RouteTableId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - } - } - }, - "DeleteSecurityGroupRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group. Required for a nondefault VPC.
" - } - } - }, - "DeleteSnapshotRequest":{ - "type":"structure", - "required":["SnapshotId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot.
" - } - } - }, - "DeleteSpotDatafeedSubscriptionRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "DeleteSubnetRequest":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
" - } - } - }, - "DeleteTagsRequest":{ - "type":"structure", - "required":["Resources"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Resources":{ - "shape":"ResourceIdList", - "documentation":"The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
", - "locationName":"resourceId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.
The ID of the volume.
" - } - } - }, - "DeleteVpcPeeringConnectionRequest":{ - "type":"structure", - "required":["VpcPeeringConnectionId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "DeleteVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the VPC.
" - } - } - }, - "DeleteVpnConnectionRequest":{ - "type":"structure", - "required":["VpnConnectionId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
" - } - } - }, - "DeleteVpnConnectionRouteRequest":{ - "type":"structure", - "required":[ - "VpnConnectionId", - "DestinationCidrBlock" - ], - "members":{ - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block associated with the local subnet of the customer network.
" - } - } - }, - "DeleteVpnGatewayRequest":{ - "type":"structure", - "required":["VpnGatewayId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - } - } - }, - "DeregisterImageRequest":{ - "type":"structure", - "required":["ImageId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - } - } - }, - "DescribeAccountAttributesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AttributeNames":{ - "shape":"AccountAttributeNameStringList", - "documentation":"One or more account attribute names.
", - "locationName":"attributeName" - } - } - }, - "DescribeAccountAttributesResult":{ - "type":"structure", - "members":{ - "AccountAttributes":{ - "shape":"AccountAttributeList", - "documentation":"Information about one or more account attributes.
", - "locationName":"accountAttributeSet" - } - } - }, - "DescribeAddressesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "PublicIps":{ - "shape":"PublicIpStringList", - "documentation":"[EC2-Classic] One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
", - "locationName":"PublicIp" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
[EC2-VPC] One or more allocation IDs.
Default: Describes all your Elastic IP addresses.
", - "locationName":"AllocationId" - } - } - }, - "DescribeAddressesResult":{ - "type":"structure", - "members":{ - "Addresses":{ - "shape":"AddressList", - "documentation":"Information about one or more Elastic IP addresses.
", - "locationName":"addressesSet" - } - } - }, - "DescribeAvailabilityZonesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ZoneNames":{ - "shape":"ZoneNameStringList", - "documentation":"The names of one or more Availability Zones.
", - "locationName":"ZoneName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
message - Information about the Availability Zone.
region-name - The name of the region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone (available | impaired | unavailable).
zone-name - The name of the Availability Zone (for example, us-east-1a).
Information about one or more Availability Zones.
", - "locationName":"availabilityZoneInfo" - } - } - }, - "DescribeBundleTasksRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "BundleIds":{ - "shape":"BundleIdStringList", - "documentation":"One or more bundle task IDs.
Default: Describes all your bundle tasks.
", - "locationName":"BundleId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
Information about one or more bundle tasks.
", - "locationName":"bundleInstanceTasksSet" - } - } - }, - "DescribeConversionTaskList":{ - "type":"list", - "member":{ - "shape":"ConversionTask", - "locationName":"item" - } - }, - "DescribeConversionTasksRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Filters":{ - "shape":"FilterList", - "locationName":"filter" - }, - "ConversionTaskIds":{ - "shape":"ConversionIdStringList", - "documentation":"One or more conversion task IDs.
", - "locationName":"conversionTaskId" - } - } - }, - "DescribeConversionTasksResult":{ - "type":"structure", - "members":{ - "ConversionTasks":{ - "shape":"DescribeConversionTaskList", - "locationName":"conversionTasks" - } - } - }, - "DescribeCustomerGatewaysRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "CustomerGatewayIds":{ - "shape":"CustomerGatewayIdStringList", - "documentation":"One or more customer gateway IDs.
Default: Describes all your customer gateways.
", - "locationName":"CustomerGatewayId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
Information about one or more customer gateways.
", - "locationName":"customerGatewaySet" - } - } - }, - "DescribeDhcpOptionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpOptionsIds":{ - "shape":"DhcpOptionsIdStringList", - "documentation":"The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
", - "locationName":"DhcpOptionsId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
dhcp-options-id - The ID of a set of DHCP options.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
Information about one or more DHCP options sets.
", - "locationName":"dhcpOptionsSet" - } - } - }, - "DescribeExportTasksRequest":{ - "type":"structure", - "members":{ - "ExportTaskIds":{ - "shape":"ExportTaskIdStringList", - "documentation":"One or more export task IDs.
", - "locationName":"exportTaskId" - } - } - }, - "DescribeExportTasksResult":{ - "type":"structure", - "members":{ - "ExportTasks":{ - "shape":"ExportTaskList", - "locationName":"exportTaskSet" - } - } - }, - "DescribeImageAttributeRequest":{ - "type":"structure", - "required":[ - "ImageId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - }, - "Attribute":{ - "shape":"ImageAttributeName", - "documentation":"The AMI attribute.
" - } - } - }, - "DescribeImagesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageIds":{ - "shape":"ImageIdStringList", - "documentation":"One or more image IDs.
Default: Describes all images available to you.
", - "locationName":"ImageId" - }, - "Owners":{ - "shape":"OwnerStringList", - "documentation":"Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request), or all (all owners).
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
One or more filters.
architecture - The image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).
description - The description of the image (provided during image creation).
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The AWS account alias (for example, amazon).
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
virtualization-type - The virtualization type (paravirtual | hvm).
Information about one or more images.
", - "locationName":"imagesSet" - } - } - }, - "DescribeInstanceAttributeRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The instance attribute.
", - "locationName":"attribute" - } - } - }, - "DescribeInstanceStatusRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
", - "locationName":"InstanceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone - The Availability Zone of the instance.
event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.
event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.
instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The next paginated set of results to return. (You received this token from a prior call.)
" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of paginated instance items per response. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
Default: 1000
" - }, - "IncludeAllInstances":{ - "shape":"Boolean", - "documentation":"When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
One or more instance status descriptions.
", - "locationName":"instanceStatusSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next paginated set of results to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeInstancesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
Default: Describes all your instances.
", - "locationName":"InstanceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
architecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use group-name instead.
group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use group-id instead.
hypervisor - The hypervisor type of the instance (ovm | xen).
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance (spot).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, m1.small).
instance.group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use instance.group-name instead.
instance.group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use instance.group-id instead.
ip-address - The public IP address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private DNS name of the instance.
private-ip-address - The private IP address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.
root-device-name - The name of the root device for the instance (for example, /dev/sda1).
root-device-type - The type of root device that the instance uses (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
tenancy - The tenancy of an instance (dedicated | default).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
network-interface.description - The description of the network interface.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
network-interface.network-interface.id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.mac-address - The MAC address of the network interface.
network-interface-private-dns-name - The private DNS name of the network interface.
network-interface.source-destination-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
The token for the next set of items to return. (You received this token from a prior call.)
", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
", - "locationName":"maxResults" - } - } - }, - "DescribeInstancesResult":{ - "type":"structure", - "members":{ - "Reservations":{ - "shape":"ReservationList", - "documentation":"One or more reservations.
", - "locationName":"reservationSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", - "locationName":"nextToken" - } - } - }, - "DescribeInternetGatewaysRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InternetGatewayIds":{ - "shape":"ValueStringList", - "documentation":"One or more Internet gateway IDs.
Default: Describes all your Internet gateways.
", - "locationName":"internetGatewayId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
Information about one or more Internet gateways.
", - "locationName":"internetGatewaySet" - } - } - }, - "DescribeKeyPairsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyNames":{ - "shape":"KeyNameStringList", - "documentation":"One or more key pair names.
Default: Describes all your key pairs.
", - "locationName":"KeyName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
Information about one or more key pairs.
", - "locationName":"keySet" - } - } - }, - "DescribeNetworkAclsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclIds":{ - "shape":"ValueStringList", - "documentation":"One or more network ACL IDs.
Default: Describes all your network ACLs.
", - "locationName":"NetworkAclId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The CIDR range specified in the entry.
entry.egress - Indicates whether the entry applies to egress traffic.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.
network-acl-id - The ID of the network ACL.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network ACL.
Information about one or more network ACLs.
", - "locationName":"networkAclSet" - } - } - }, - "DescribeNetworkInterfaceAttributeRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "Attribute":{ - "shape":"NetworkInterfaceAttribute", - "documentation":"The attribute of the network interface.
", - "locationName":"attribute" - } - } - }, - "DescribeNetworkInterfaceAttributeResult":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "Description":{ - "shape":"AttributeValue", - "documentation":"The description of the network interface.
", - "locationName":"description" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether source/destination checking is enabled.
", - "locationName":"sourceDestCheck" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"The security groups associated with the network interface.
", - "locationName":"groupSet" - }, - "Attachment":{ - "shape":"NetworkInterfaceAttachment", - "documentation":"The attachment (if any) of the network interface.
", - "locationName":"attachment" - } - } - }, - "DescribeNetworkInterfacesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceIds":{ - "shape":"NetworkInterfaceIdList", - "documentation":"One or more network interface IDs.
Default: Describes all your network interfaces.
", - "locationName":"NetworkInterfaceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
addresses.private-ip-address - The private IP addresses associated with the network interface.
addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.public-dns-name - The public DNS name for the network interface.
attachment.attachment-id - The ID of the interface attachment.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.device-index - The device index to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
attachment.attach.time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IP address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network interface.
Information about one or more network interfaces.
", - "locationName":"networkInterfaceSet" - } - } - }, - "DescribePlacementGroupsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupNames":{ - "shape":"PlacementGroupStringList", - "documentation":"One or more placement group names.
Default: Describes all your placement groups, or only those otherwise specified.
", - "locationName":"groupName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster).
One or more placement groups.
", - "locationName":"placementGroupSet" - } - } - }, - "DescribeRegionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RegionNames":{ - "shape":"RegionNameStringList", - "documentation":"The names of one or more regions.
", - "locationName":"RegionName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for example, us-east-1).
Information about one or more regions.
", - "locationName":"regionInfo" - } - } - }, - "DescribeReservedInstancesListingsRequest":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"One or more Reserved Instance IDs.
", - "locationName":"reservedInstancesId" - }, - "ReservedInstancesListingId":{ - "shape":"String", - "documentation":"One or more Reserved Instance Listing IDs.
", - "locationName":"reservedInstancesListingId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
Information about the Reserved Instance listing.
", - "locationName":"reservedInstancesListingsSet" - } - } - }, - "DescribeReservedInstancesModificationsRequest":{ - "type":"structure", - "members":{ - "ReservedInstancesModificationIds":{ - "shape":"ReservedInstancesModificationIdStringList", - "documentation":"IDs for the submitted modification request.
", - "locationName":"ReservedInstancesModificationId" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token for the next page of data.
", - "locationName":"nextToken" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
The Reserved Instance modification information.
", - "locationName":"reservedInstancesModificationsSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token for the next page of data.
", - "locationName":"nextToken" - } - } - }, - "DescribeReservedInstancesOfferingsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ReservedInstancesOfferingIds":{ - "shape":"ReservedInstancesOfferingIdStringList", - "documentation":"One or more Reserved Instances offering IDs.
", - "locationName":"ReservedInstancesOfferingId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.
product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).
reserved-instances-offering-id - The Reserved Instances offering ID.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.
Default: default
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
The token to use when requesting the next paginated set of offerings.
", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of offerings to return. The maximum is 100.
Default: 100
", - "locationName":"maxResults" - }, - "IncludeMarketplace":{ - "shape":"Boolean", - "documentation":"Include Marketplace offerings in the response.
" - }, - "MinDuration":{ - "shape":"Long", - "documentation":"The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
" - }, - "MaxDuration":{ - "shape":"Long", - "documentation":"The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
" - }, - "MaxInstanceCount":{ - "shape":"Integer", - "documentation":"The maximum number of instances to filter when searching for offerings.
Default: 20
" - } - } - }, - "DescribeReservedInstancesOfferingsResult":{ - "type":"structure", - "members":{ - "ReservedInstancesOfferings":{ - "shape":"ReservedInstancesOfferingList", - "documentation":"A list of Reserved Instances offerings.
", - "locationName":"reservedInstancesOfferingsSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next paginated set of results to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeReservedInstancesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ReservedInstancesIds":{ - "shape":"ReservedInstancesIdStringList", - "documentation":"One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
", - "locationName":"ReservedInstancesId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
A list of Reserved Instances.
", - "locationName":"reservedInstancesSet" - } - } - }, - "DescribeRouteTablesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableIds":{ - "shape":"ValueStringList", - "documentation":"One or more route table IDs.
Default: Describes all your route tables.
", - "locationName":"RouteTableId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC.
route-table-id - The ID of the route table.
route.destination-cidr-block - The CIDR range specified in a route in the table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the route table.
Information about one or more route tables.
", - "locationName":"routeTableSet" - } - } - }, - "DescribeSecurityGroupsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupNames":{ - "shape":"GroupNameStringList", - "documentation":"[EC2-Classic, default VPC] One or more security group names. You can specify either the security group name or the security group ID.
Default: Describes all your security groups.
", - "locationName":"GroupName" - }, - "GroupIds":{ - "shape":"GroupIdStringList", - "documentation":"One or more security group IDs. Required for nondefault VPCs.
Default: Describes all your security groups.
", - "locationName":"GroupId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
description - The description of the security group.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - A CIDR range that has been granted permission.
ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been granted permission.
ip-permission.group-name - The name of a security group that has been granted permission.
ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).
ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been granted permission.
owner-id - The AWS account ID of the owner of the security group.
tag-key - The key of a tag assigned to the security group.
tag-value - The value of a tag assigned to the security group.
vpc-id - The ID of the VPC specified when the security group was created.
Information about one or more security groups.
", - "locationName":"securityGroupInfo" - } - } - }, - "DescribeSnapshotAttributeRequest":{ - "type":"structure", - "required":[ - "SnapshotId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot.
" - }, - "Attribute":{ - "shape":"SnapshotAttributeName", - "documentation":"The snapshot attribute you would like to view.
" - } - } - }, - "DescribeSnapshotAttributeResult":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot.
", - "locationName":"snapshotId" - }, - "CreateVolumePermissions":{ - "shape":"CreateVolumePermissionList", - "documentation":"A list of permissions for creating volumes from the snapshot.
", - "locationName":"createVolumePermission" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"A list of product codes.
", - "locationName":"productCodes" - } - } - }, - "DescribeSnapshotsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotIds":{ - "shape":"SnapshotIdStringList", - "documentation":"One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
", - "locationName":"SnapshotId" - }, - "OwnerIds":{ - "shape":"OwnerStringList", - "documentation":"Returns the snapshots owned by the specified owner. Multiple owners can be specified.
", - "locationName":"Owner" - }, - "RestorableByUserIds":{ - "shape":"RestorableByStringList", - "documentation":"One or more AWS accounts IDs that can create volumes from the snapshot.
", - "locationName":"RestorableBy" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
description - A description of the snapshot.
owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
The Spot Instance datafeed subscription.
", - "locationName":"spotDatafeedSubscription" - } - } - }, - "DescribeSpotInstanceRequestsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SpotInstanceRequestIds":{ - "shape":"SpotInstanceRequestIdList", - "documentation":"One or more Spot Instance request IDs.
", - "locationName":"SpotInstanceRequestId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).
launch.group-id - The security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m1.small).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
network-interface.network-interface-id - The ID of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.subnet-id - The ID of the subnet for the instance.
network-interface.description - A description of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.group-name - The name of the security group associated with the network interface.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of Spot Instance request (one-time | persistent).
launched-availability-zone - The Availability Zone in which the bid is launched.
valid-from - The start date of the request.
valid-until - The end date of the request.
One or more Spot Instance requests.
", - "locationName":"spotInstanceRequestSet" - } - } - }, - "DescribeSpotPriceHistoryRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The start date and time of the Spot Price history data.
", - "locationName":"startTime" - }, - "EndTime":{ - "shape":"DateTime", - "documentation":"The end date and time of the Spot Price history data.
", - "locationName":"endTime" - }, - "InstanceTypes":{ - "shape":"InstanceTypeList", - "documentation":"One or more instance types.
", - "locationName":"InstanceType" - }, - "ProductDescriptions":{ - "shape":"ProductDescriptionList", - "documentation":"One or more basic product descriptions.
", - "locationName":"ProductDescription" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m1.small).
product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
The Availability Zone.
", - "locationName":"availabilityZone" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The number of rows to return.
", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next set of rows to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeSpotPriceHistoryResult":{ - "type":"structure", - "members":{ - "SpotPriceHistory":{ - "shape":"SpotPriceHistoryList", - "documentation":"The historical Spot Prices.
", - "locationName":"spotPriceHistorySet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The string marking the next set of results. This is empty if there are no more results.
", - "locationName":"nextToken" - } - } - }, - "DescribeSubnetsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SubnetIds":{ - "shape":"SubnetIdStringList", - "documentation":"One or more subnet IDs.
Default: Describes all your subnets.
", - "locationName":"SubnetId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.
available-ip-address-count - The number of IP addresses in the subnet that are available.
cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.
defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.
state - The state of the subnet (pending | available).
subnet-id - The ID of the subnet.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the subnet.
Information about one or more subnets.
", - "locationName":"subnetSet" - } - } - }, - "DescribeTagsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
key - The tag key.
resource-id - The resource ID.
resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).
value - The tag value.
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token for the next set of items to return. (You received this token from a prior call.)
", - "locationName":"nextToken" - } - } - }, - "DescribeTagsResult":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagDescriptionList", - "documentation":"A list of tags.
", - "locationName":"tagSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", - "locationName":"nextToken" - } - } - }, - "DescribeVolumeAttributeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
" - }, - "Attribute":{ - "shape":"VolumeAttributeName", - "documentation":"The instance attribute.
" - } - } - }, - "DescribeVolumeAttributeResult":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "AutoEnableIO":{ - "shape":"AttributeBooleanValue", - "documentation":"The state of autoEnableIO attribute.
A list of product codes.
", - "locationName":"productCodes" - } - } - }, - "DescribeVolumeStatusRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeIds":{ - "shape":"VolumeIdStringList", - "documentation":"One or more volume IDs.
Default: Describes all your volumes.
", - "locationName":"VolumeId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The next paginated set of results to return using the pagination token returned by a previous call.
" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of paginated volume items per response.
" - } - } - }, - "DescribeVolumeStatusResult":{ - "type":"structure", - "members":{ - "VolumeStatuses":{ - "shape":"VolumeStatusList", - "documentation":"A list of volumes.
", - "locationName":"volumeStatusSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next paginated set of results to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeVolumesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeIds":{ - "shape":"VolumeIdStringList", - "documentation":"One or more volume IDs.
", - "locationName":"VolumeId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching | detached).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status of the volume (creating | available | in-use | deleting | deleted | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results.
The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the VPC.
" - }, - "Attribute":{ - "shape":"VpcAttributeName", - "documentation":"The VPC attribute.
" - } - } - }, - "DescribeVpcAttributeResult":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "EnableDnsSupport":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
", - "locationName":"VpcPeeringConnectionId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.
accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id - The ID of the peer VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-peering-connection-id - The ID of the VPC peering connection.
Information about the VPC peering connections.
", - "locationName":"vpcPeeringConnectionSet" - } - } - }, - "DescribeVpcsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcIds":{ - "shape":"VpcIdStringList", - "documentation":"One or more VPC IDs.
Default: Describes all your VPCs.
", - "locationName":"VpcId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
dhcp-options-id - The ID of a set of DHCP options.
isDefault - Indicates whether the VPC is the default VPC.
state - The state of the VPC (pending | available).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC.
Information about one or more VPCs.
", - "locationName":"vpcSet" - } - } - }, - "DescribeVpnConnectionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnConnectionIds":{ - "shape":"VpnConnectionIdStringList", - "documentation":"One or more VPN connection IDs.
Default: Describes your VPN connections.
", - "locationName":"VpnConnectionId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
Information about one or more VPN connections.
", - "locationName":"vpnConnectionSet" - } - } - }, - "DescribeVpnGatewaysRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnGatewayIds":{ - "shape":"VpnGatewayIdStringList", - "documentation":"One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
", - "locationName":"VpnGatewayId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway.
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
Information about one or more virtual private gateways.
", - "locationName":"vpnGatewaySet" - } - } - }, - "DetachInternetGatewayRequest":{ - "type":"structure", - "required":[ - "InternetGatewayId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InternetGatewayId":{ - "shape":"String", - "documentation":"The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "DetachNetworkInterfaceRequest":{ - "type":"structure", - "required":["AttachmentId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the attachment.
", - "locationName":"attachmentId" - }, - "Force":{ - "shape":"Boolean", - "documentation":"Specifies whether to force a detachment.
", - "locationName":"force" - } - } - }, - "DetachVolumeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - }, - "Device":{ - "shape":"String", - "documentation":"The device name.
" - }, - "Force":{ - "shape":"Boolean", - "documentation":"Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
" - } - } - }, - "DetachVpnGatewayRequest":{ - "type":"structure", - "required":[ - "VpnGatewayId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
" - } - } - }, - "DeviceType":{ - "type":"string", - "enum":[ - "ebs", - "instance-store" - ] - }, - "DhcpConfiguration":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"The name of a DHCP option.
", - "locationName":"key" - }, - "Values":{ - "shape":"DhcpConfigurationValueList", - "documentation":"One or more values for the DHCP option.
", - "locationName":"valueSet" - } - }, - "documentation":"Describes a DHCP configuration option.
" - }, - "DhcpConfigurationList":{ - "type":"list", - "member":{ - "shape":"DhcpConfiguration", - "locationName":"item" - } - }, - "DhcpOptions":{ - "type":"structure", - "members":{ - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the set of DHCP options.
", - "locationName":"dhcpOptionsId" - }, - "DhcpConfigurations":{ - "shape":"DhcpConfigurationList", - "documentation":"One or more DHCP options in the set.
", - "locationName":"dhcpConfigurationSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the DHCP options set.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a set of DHCP options.
" - }, - "DhcpOptionsIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"DhcpOptionsId" - } - }, - "DhcpOptionsList":{ - "type":"list", - "member":{ - "shape":"DhcpOptions", - "locationName":"item" - } - }, - "DisableVgwRoutePropagationRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "GatewayId" - ], - "members":{ - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - } - } - }, - "DisassociateAddressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "PublicIp":{ - "shape":"String", - "documentation":"[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" - }, - "AssociationId":{ - "shape":"String", - "documentation":"[EC2-VPC] The association ID. Required for EC2-VPC.
" - } - } - }, - "DisassociateRouteTableRequest":{ - "type":"structure", - "required":["AssociationId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The association ID representing the current association between the route table and subnet.
", - "locationName":"associationId" - } - } - }, - "DiskImage":{ - "type":"structure", - "members":{ - "Image":{"shape":"DiskImageDetail"}, - "Description":{"shape":"String"}, - "Volume":{"shape":"VolumeDetail"} - }, - "documentation":"Describes a disk image.
" - }, - "DiskImageDescription":{ - "type":"structure", - "required":[ - "Format", - "Size", - "ImportManifestUrl" - ], - "members":{ - "Format":{ - "shape":"DiskImageFormat", - "documentation":"The disk image format.
", - "locationName":"format" - }, - "Size":{ - "shape":"Long", - "documentation":"The size of the disk image.
", - "locationName":"size" - }, - "ImportManifestUrl":{ - "shape":"String", - "documentation":"A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
", - "locationName":"importManifestUrl" - }, - "Checksum":{ - "shape":"String", - "documentation":"The checksum computed for the disk image.
", - "locationName":"checksum" - } - } - }, - "DiskImageDetail":{ - "type":"structure", - "required":[ - "Format", - "Bytes", - "ImportManifestUrl" - ], - "members":{ - "Format":{ - "shape":"DiskImageFormat", - "documentation":"The disk image format.
", - "locationName":"format" - }, - "Bytes":{ - "shape":"Long", - "locationName":"bytes" - }, - "ImportManifestUrl":{ - "shape":"String", - "documentation":"A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
", - "locationName":"importManifestUrl" - } - } - }, - "DiskImageFormat":{ - "type":"string", - "enum":[ - "VMDK", - "RAW", - "VHD" - ] - }, - "DiskImageList":{ - "type":"list", - "member":{"shape":"DiskImage"} - }, - "DiskImageVolumeDescription":{ - "type":"structure", - "required":["Id"], - "members":{ - "Size":{ - "shape":"Long", - "documentation":"The size of the volume.
", - "locationName":"size" - }, - "Id":{ - "shape":"String", - "documentation":"The volume identifier.
", - "locationName":"id" - } - } - }, - "DomainType":{ - "type":"string", - "enum":[ - "vpc", - "standard" - ] - }, - "Double":{"type":"double"}, - "EbsBlockDevice":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot.
", - "locationName":"snapshotId" - }, - "VolumeSize":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiB.
Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
", - "locationName":"volumeSize" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the Amazon EBS volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - }, - "VolumeType":{ - "shape":"VolumeType", - "documentation":"The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
", - "locationName":"encrypted" - } - }, - "documentation":"Describes an Amazon EBS block device.
" - }, - "EbsInstanceBlockDevice":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume.
", - "locationName":"volumeId" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"The attachment state.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes a parameter used to set up an Amazon EBS volume in a block device mapping.
" - }, - "EbsInstanceBlockDeviceSpecification":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume.
", - "locationName":"volumeId" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - } - } - }, - "EnableVgwRoutePropagationRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "GatewayId" - ], - "members":{ - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - } - } - }, - "EnableVolumeIORequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - } - } - }, - "EventCode":{ - "type":"string", - "enum":[ - "instance-reboot", - "system-reboot", - "system-maintenance", - "instance-retirement", - "instance-stop" - ] - }, - "ExecutableByStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ExecutableBy" - } - }, - "ExportEnvironment":{ - "type":"string", - "enum":[ - "citrix", - "vmware", - "microsoft" - ] - }, - "ExportTask":{ - "type":"structure", - "members":{ - "ExportTaskId":{ - "shape":"String", - "documentation":"The ID of the export task.
", - "locationName":"exportTaskId" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the resource being exported.
", - "locationName":"description" - }, - "State":{ - "shape":"ExportTaskState", - "documentation":"The state of the conversion task.
", - "locationName":"state" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The status message related to the export task.
", - "locationName":"statusMessage" - }, - "InstanceExportDetails":{ - "shape":"InstanceExportDetails", - "documentation":"The instance being exported.
", - "locationName":"instanceExport" - }, - "ExportToS3Task":{ - "shape":"ExportToS3Task", - "locationName":"exportToS3" - } - }, - "documentation":"Describes an export task.
" - }, - "ExportTaskIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ExportTaskId" - } - }, - "ExportTaskList":{ - "type":"list", - "member":{ - "shape":"ExportTask", - "locationName":"item" - } - }, - "ExportTaskState":{ - "type":"string", - "enum":[ - "active", - "cancelling", - "cancelled", - "completed" - ] - }, - "ExportToS3Task":{ - "type":"structure", - "members":{ - "DiskImageFormat":{ - "shape":"DiskImageFormat", - "documentation":"The format for the exported image.
", - "locationName":"diskImageFormat" - }, - "ContainerFormat":{ - "shape":"ContainerFormat", - "documentation":"The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
", - "locationName":"containerFormat" - }, - "S3Bucket":{ - "shape":"String", - "documentation":"The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACL permissions to the AWS account vm-import-export@amazon.com.
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
", - "locationName":"s3Prefix" - } - } - }, - "Filter":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the filter.
" - }, - "Values":{ - "shape":"ValueStringList", - "documentation":"One or more filter values.
", - "locationName":"Value" - } - } - }, - "FilterList":{ - "type":"list", - "member":{ - "shape":"Filter", - "locationName":"Filter" - } - }, - "Float":{"type":"float"}, - "GatewayType":{ - "type":"string", - "enum":["ipsec.1"] - }, - "GetConsoleOutputRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - } - } - }, - "GetConsoleOutputResult":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Timestamp":{ - "shape":"DateTime", - "documentation":"The time the output was last updated.
", - "locationName":"timestamp" - }, - "Output":{ - "shape":"String", - "documentation":"The console output, Base64 encoded.
", - "locationName":"output" - } - } - }, - "GetPasswordDataRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the Windows instance.
" - } - } - }, - "GetPasswordDataResult":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the Windows instance.
", - "locationName":"instanceId" - }, - "Timestamp":{ - "shape":"DateTime", - "documentation":"The time the data was last updated.
", - "locationName":"timestamp" - }, - "PasswordData":{ - "shape":"String", - "documentation":"The password of the instance.
", - "locationName":"passwordData" - } - } - }, - "GroupIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"groupId" - } - }, - "GroupIdentifier":{ - "type":"structure", - "members":{ - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
", - "locationName":"groupName" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - } - }, - "documentation":"Describes a security group.
" - }, - "GroupIdentifierList":{ - "type":"list", - "member":{ - "shape":"GroupIdentifier", - "locationName":"item" - } - }, - "GroupNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"GroupName" - } - }, - "HypervisorType":{ - "type":"string", - "enum":[ - "ovm", - "xen" - ] - }, - "IamInstanceProfile":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the instance profile.
", - "locationName":"arn" - }, - "Id":{ - "shape":"String", - "documentation":"The ID of the instance profile.
", - "locationName":"id" - } - }, - "documentation":"Describes an IAM instance profile.
" - }, - "IamInstanceProfileSpecification":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the instance profile.
", - "locationName":"arn" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the instance profile.
", - "locationName":"name" - } - }, - "documentation":"Describes an IAM instance profile.
" - }, - "IcmpTypeCode":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"Integer", - "documentation":"The ICMP code. A value of -1 means all codes for the specified ICMP type.
", - "locationName":"type" - }, - "Code":{ - "shape":"Integer", - "documentation":"The ICMP type. A value of -1 means all types.
", - "locationName":"code" - } - }, - "documentation":"Describes the ICMP type and code.
" - }, - "Image":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "ImageLocation":{ - "shape":"String", - "documentation":"The location of the AMI.
", - "locationName":"imageLocation" - }, - "State":{ - "shape":"ImageState", - "documentation":"The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The AWS account ID of the image owner.
", - "locationName":"imageOwnerId" - }, - "Public":{ - "shape":"Boolean", - "documentation":"Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
Any product codes associated with the AMI.
", - "locationName":"productCodes" - }, - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the image.
", - "locationName":"architecture" - }, - "ImageType":{ - "shape":"ImageTypeValues", - "documentation":"The type of image.
", - "locationName":"imageType" - }, - "KernelId":{ - "shape":"String", - "documentation":"The kernel associated with the image, if any. Only applicable for machine images.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The RAM disk associated with the image, if any. Only applicable for machine images.
", - "locationName":"ramdiskId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The value is Windows for Windows AMIs; otherwise blank.
Specifies whether enhanced networking is enabled.
", - "locationName":"sriovNetSupport" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"The reason for the state change.
", - "locationName":"stateReason" - }, - "ImageOwnerAlias":{ - "shape":"String", - "documentation":"The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
The name of the AMI that was provided during image creation.
", - "locationName":"name" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the AMI that was provided during image creation.
", - "locationName":"description" - }, - "RootDeviceType":{ - "shape":"DeviceType", - "documentation":"The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
", - "locationName":"rootDeviceType" - }, - "RootDeviceName":{ - "shape":"String", - "documentation":"The device name of the root device (for example,
Any block device mapping entries.
", - "locationName":"blockDeviceMapping" - }, - "VirtualizationType":{ - "shape":"VirtualizationType", - "documentation":"The type of virtualization of the AMI.
", - "locationName":"virtualizationType" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the image.
", - "locationName":"tagSet" - }, - "Hypervisor":{ - "shape":"HypervisorType", - "documentation":"The hypervisor type of the image.
", - "locationName":"hypervisor" - } - }, - "documentation":"Describes an image.
" - }, - "ImageAttribute":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "LaunchPermissions":{ - "shape":"LaunchPermissionList", - "documentation":"One or more launch permissions.
", - "locationName":"launchPermission" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"One or more product codes.
", - "locationName":"productCodes" - }, - "KernelId":{ - "shape":"AttributeValue", - "documentation":"The kernel ID.
", - "locationName":"kernel" - }, - "RamdiskId":{ - "shape":"AttributeValue", - "documentation":"The RAM disk ID.
", - "locationName":"ramdisk" - }, - "Description":{ - "shape":"AttributeValue", - "documentation":"A description for the AMI.
", - "locationName":"description" - }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "locationName":"sriovNetSupport" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"One or more block device mapping entries.
", - "locationName":"blockDeviceMapping" - } - }, - "documentation":"Describes an image attribute.
" - }, - "ImageAttributeName":{ - "type":"string", - "enum":[ - "description", - "kernel", - "ramdisk", - "launchPermission", - "productCodes", - "blockDeviceMapping" - ] - }, - "ImageIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ImageId" - } - }, - "ImageList":{ - "type":"list", - "member":{ - "shape":"Image", - "locationName":"item" - } - }, - "ImageState":{ - "type":"string", - "enum":[ - "available", - "deregistered" - ] - }, - "ImageTypeValues":{ - "type":"string", - "enum":[ - "machine", - "kernel", - "ramdisk" - ] - }, - "ImportInstanceLaunchSpecification":{ - "type":"structure", - "members":{ - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the instance.
", - "locationName":"architecture" - }, - "GroupNames":{ - "shape":"SecurityGroupStringList", - "documentation":"One or more security group names.
", - "locationName":"GroupName" - }, - "GroupIds":{ - "shape":"SecurityGroupIdStringList", - "locationName":"GroupId" - }, - "AdditionalInfo":{ - "shape":"String", - "locationName":"additionalInfo" - }, - "UserData":{ - "shape":"String", - "documentation":"User data to be made available to the instance.
", - "locationName":"userData" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
", - "locationName":"instanceType" - }, - "Placement":{ - "shape":"Placement", - "locationName":"placement" - }, - "Monitoring":{ - "shape":"Boolean", - "locationName":"monitoring" - }, - "SubnetId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the subnet to launch the instance into.
", - "locationName":"subnetId" - }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"ShutdownBehavior", - "documentation":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.
", - "locationName":"privateIpAddress" - } - } - }, - "ImportInstanceRequest":{ - "type":"structure", - "required":["Platform"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the instance being imported.
", - "locationName":"description" - }, - "LaunchSpecification":{ - "shape":"ImportInstanceLaunchSpecification", - "documentation":"", - "locationName":"launchSpecification" - }, - "DiskImages":{ - "shape":"DiskImageList", - "locationName":"diskImage" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The instance operating system.
", - "locationName":"platform" - } - } - }, - "ImportInstanceResult":{ - "type":"structure", - "members":{ - "ConversionTask":{ - "shape":"ConversionTask", - "locationName":"conversionTask" - } - } - }, - "ImportInstanceTaskDetails":{ - "type":"structure", - "required":["Volumes"], - "members":{ - "Volumes":{ - "shape":"ImportInstanceVolumeDetailSet", - "locationName":"volumes" - }, - "InstanceId":{ - "shape":"String", - "locationName":"instanceId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The instance operating system.
", - "locationName":"platform" - }, - "Description":{ - "shape":"String", - "locationName":"description" - } - } - }, - "ImportInstanceVolumeDetailItem":{ - "type":"structure", - "required":[ - "BytesConverted", - "AvailabilityZone", - "Image", - "Volume", - "Status" - ], - "members":{ - "BytesConverted":{ - "shape":"Long", - "documentation":"The number of bytes converted so far.
", - "locationName":"bytesConverted" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where the resulting instance will reside.
", - "locationName":"availabilityZone" - }, - "Image":{ - "shape":"DiskImageDescription", - "documentation":"The image.
", - "locationName":"image" - }, - "Volume":{ - "shape":"DiskImageVolumeDescription", - "documentation":"The volume.
", - "locationName":"volume" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the import of this particular disk image.
", - "locationName":"status" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The status information or errors related to the disk image.
", - "locationName":"statusMessage" - }, - "Description":{ - "shape":"String", - "locationName":"description" - } - }, - "documentation":"Describes an import volume task.
" - }, - "ImportInstanceVolumeDetailSet":{ - "type":"list", - "member":{ - "shape":"ImportInstanceVolumeDetailItem", - "locationName":"item" - } - }, - "ImportKeyPairRequest":{ - "type":"structure", - "required":[ - "KeyName", - "PublicKeyMaterial" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyName":{ - "shape":"String", - "documentation":"A unique name for the key pair.
", - "locationName":"keyName" - }, - "PublicKeyMaterial":{ - "shape":"Blob", - "documentation":"The public key. You must base64 encode the public key material before sending it to AWS.
", - "locationName":"publicKeyMaterial" - } - } - }, - "ImportKeyPairResult":{ - "type":"structure", - "members":{ - "KeyName":{ - "shape":"String", - "documentation":"The key pair name you provided.
", - "locationName":"keyName" - }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"The MD5 public key fingerprint as specified in section 4 of RFC 4716.
", - "locationName":"keyFingerprint" - } - } - }, - "ImportVolumeRequest":{ - "type":"structure", - "required":[ - "AvailabilityZone", - "Image", - "Volume" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the resulting Amazon EBS volume.
", - "locationName":"availabilityZone" - }, - "Image":{ - "shape":"DiskImageDetail", - "locationName":"image" - }, - "Description":{ - "shape":"String", - "documentation":"An optional description for the volume being imported.
", - "locationName":"description" - }, - "Volume":{ - "shape":"VolumeDetail", - "locationName":"volume" - } - } - }, - "ImportVolumeResult":{ - "type":"structure", - "members":{ - "ConversionTask":{ - "shape":"ConversionTask", - "locationName":"conversionTask" - } - } - }, - "ImportVolumeTaskDetails":{ - "type":"structure", - "required":[ - "BytesConverted", - "AvailabilityZone", - "Image", - "Volume" - ], - "members":{ - "BytesConverted":{ - "shape":"Long", - "documentation":"The number of bytes converted so far.
", - "locationName":"bytesConverted" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where the resulting volume will reside.
", - "locationName":"availabilityZone" - }, - "Description":{ - "shape":"String", - "documentation":"The description you provided when starting the import volume task.
", - "locationName":"description" - }, - "Image":{ - "shape":"DiskImageDescription", - "documentation":"The image.
", - "locationName":"image" - }, - "Volume":{ - "shape":"DiskImageVolumeDescription", - "documentation":"The volume.
", - "locationName":"volume" - } - }, - "documentation":"Describes an import volume task.
" - }, - "Instance":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI used to launch the instance.
", - "locationName":"imageId" - }, - "State":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
", - "locationName":"instanceState" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
The public DNS name assigned to the instance. This name is not available until the instance enters the running state.
The reason for the most recent state transition. This might be an empty string.
", - "locationName":"reason" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair, if this instance was launched with an associated key pair.
", - "locationName":"keyName" - }, - "AmiLaunchIndex":{ - "shape":"Integer", - "documentation":"The AMI launch index, which can be used to find this instance in the launch group.
", - "locationName":"amiLaunchIndex" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"The product codes attached to this instance.
", - "locationName":"productCodes" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "LaunchTime":{ - "shape":"DateTime", - "documentation":"The time the instance was launched.
", - "locationName":"launchTime" - }, - "Placement":{ - "shape":"Placement", - "documentation":"The location where the instance launched.
", - "locationName":"placement" - }, - "KernelId":{ - "shape":"String", - "documentation":"The kernel associated with this instance.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The RAM disk associated with this instance.
", - "locationName":"ramdiskId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The value is Windows for Windows instances; otherwise blank.
The monitoring information for the instance.
", - "locationName":"monitoring" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which the instance is running.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC in which the instance is running.
", - "locationName":"vpcId" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address assigned to the instance.
", - "locationName":"privateIpAddress" - }, - "PublicIpAddress":{ - "shape":"String", - "documentation":"The public IP address assigned to the instance.
", - "locationName":"ipAddress" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"The reason for the most recent state transition.
", - "locationName":"stateReason" - }, - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the image.
", - "locationName":"architecture" - }, - "RootDeviceType":{ - "shape":"DeviceType", - "documentation":"The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
", - "locationName":"rootDeviceType" - }, - "RootDeviceName":{ - "shape":"String", - "documentation":"The root device name (for example, /dev/sda1).
Any block device mapping entries for the instance.
", - "locationName":"blockDeviceMapping" - }, - "VirtualizationType":{ - "shape":"VirtualizationType", - "documentation":"The virtualization type of the instance.
", - "locationName":"virtualizationType" - }, - "InstanceLifecycle":{ - "shape":"InstanceLifecycleType", - "documentation":"Indicates whether this is a Spot Instance.
", - "locationName":"instanceLifecycle" - }, - "SpotInstanceRequestId":{ - "shape":"String", - "documentation":"The ID of the Spot Instance request.
", - "locationName":"spotInstanceRequestId" - }, - "ClientToken":{ - "shape":"String", - "documentation":"The idempotency token you provided when you launched the instance.
", - "locationName":"clientToken" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the instance.
", - "locationName":"tagSet" - }, - "SecurityGroups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups for the instance.
", - "locationName":"groupSet" - }, - "SourceDestCheck":{ - "shape":"Boolean", - "documentation":"Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
The hypervisor type of the instance.
", - "locationName":"hypervisor" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceList", - "documentation":"[EC2-VPC] One or more network interfaces for the instance.
", - "locationName":"networkInterfaceSet" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfile", - "documentation":"The IAM instance profile associated with the instance.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", - "locationName":"ebsOptimized" - }, - "SriovNetSupport":{ - "shape":"String", - "documentation":"Specifies whether enhanced networking is enabled.
", - "locationName":"sriovNetSupport" - } - }, - "documentation":"Describes an instance.
" - }, - "InstanceAttribute":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "InstanceType":{ - "shape":"AttributeValue", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "KernelId":{ - "shape":"AttributeValue", - "documentation":"The kernel ID.
", - "locationName":"kernel" - }, - "RamdiskId":{ - "shape":"AttributeValue", - "documentation":"The RAM disk ID.
", - "locationName":"ramdisk" - }, - "UserData":{ - "shape":"AttributeValue", - "documentation":"The Base64-encoded MIME user data.
", - "locationName":"userData" - }, - "DisableApiTermination":{ - "shape":"AttributeBooleanValue", - "documentation":"If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, - "RootDeviceName":{ - "shape":"AttributeValue", - "documentation":"The name of the root device (for example, /dev/sda1).
The block device mapping of the instance.
", - "locationName":"blockDeviceMapping" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"A list of product codes.
", - "locationName":"productCodes" - }, - "EbsOptimized":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the instance is optimized for EBS I/O.
", - "locationName":"ebsOptimized" - }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "locationName":"sriovNetSupport" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
The security groups associated with the instance.
", - "locationName":"groupSet" - } - }, - "documentation":"Describes an instance attribute.
" - }, - "InstanceAttributeName":{ - "type":"string", - "enum":[ - "instanceType", - "kernel", - "ramdisk", - "userData", - "disableApiTermination", - "instanceInitiatedShutdownBehavior", - "rootDeviceName", - "blockDeviceMapping", - "productCodes", - "sourceDestCheck", - "groupSet", - "ebsOptimized", - "sriovNetSupport" - ] - }, - "InstanceBlockDeviceMapping":{ - "type":"structure", - "members":{ - "DeviceName":{ - "shape":"String", - "documentation":"The device name exposed to the instance (for example,
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
", - "locationName":"ebs" - } - }, - "documentation":"Describes a block device mapping.
" - }, - "InstanceBlockDeviceMappingList":{ - "type":"list", - "member":{ - "shape":"InstanceBlockDeviceMapping", - "locationName":"item" - } - }, - "InstanceBlockDeviceMappingSpecification":{ - "type":"structure", - "members":{ - "DeviceName":{ - "shape":"String", - "documentation":"The device name exposed to the instance (for example,
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
", - "locationName":"ebs" - }, - "VirtualName":{ - "shape":"String", - "documentation":"The virtual device name.
", - "locationName":"virtualName" - }, - "NoDevice":{ - "shape":"String", - "documentation":"suppress the specified device included in the block device mapping.
", - "locationName":"noDevice" - } - }, - "documentation":"Describes a block device mapping entry.
" - }, - "InstanceBlockDeviceMappingSpecificationList":{ - "type":"list", - "member":{ - "shape":"InstanceBlockDeviceMappingSpecification", - "locationName":"item" - } - }, - "InstanceCount":{ - "type":"structure", - "members":{ - "State":{ - "shape":"ListingState", - "documentation":"The states of the listed Reserved Instances.
", - "locationName":"state" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"he number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
" - }, - "InstanceCountList":{ - "type":"list", - "member":{ - "shape":"InstanceCount", - "locationName":"item" - } - }, - "InstanceExportDetails":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the resource being exported.
", - "locationName":"instanceId" - }, - "TargetEnvironment":{ - "shape":"ExportEnvironment", - "documentation":"The target virtualization environment.
", - "locationName":"targetEnvironment" - } - }, - "documentation":"Describes an instance export task.
" - }, - "InstanceIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"InstanceId" - } - }, - "InstanceLifecycleType":{ - "type":"string", - "enum":["spot"] - }, - "InstanceList":{ - "type":"list", - "member":{ - "shape":"Instance", - "locationName":"item" - } - }, - "InstanceMonitoring":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Monitoring":{ - "shape":"Monitoring", - "documentation":"The monitoring information.
", - "locationName":"monitoring" - } - }, - "documentation":"Describes the monitoring information of the instance.
" - }, - "InstanceMonitoringList":{ - "type":"list", - "member":{ - "shape":"InstanceMonitoring", - "locationName":"item" - } - }, - "InstanceNetworkInterface":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "Description":{ - "shape":"String", - "documentation":"The description.
", - "locationName":"description" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The ID of the AWS account that created the network interface.
", - "locationName":"ownerId" - }, - "Status":{ - "shape":"NetworkInterfaceStatus", - "documentation":"The status of the network interface.
", - "locationName":"status" - }, - "MacAddress":{ - "shape":"String", - "documentation":"The MAC address.
", - "locationName":"macAddress" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The IP address of the network interface within the subnet.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "SourceDestCheck":{ - "shape":"Boolean", - "documentation":"Indicates whether to validate network traffic to or from this network interface.
", - "locationName":"sourceDestCheck" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups.
", - "locationName":"groupSet" - }, - "Attachment":{ - "shape":"InstanceNetworkInterfaceAttachment", - "documentation":"The network interface attachment.
", - "locationName":"attachment" - }, - "Association":{ - "shape":"InstanceNetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP associated with the network interface.
", - "locationName":"association" - }, - "PrivateIpAddresses":{ - "shape":"InstancePrivateIpAddressList", - "documentation":"The private IP addresses associated with the network interface.
", - "locationName":"privateIpAddressesSet" - } - }, - "documentation":"Describes a network interface.
" - }, - "InstanceNetworkInterfaceAssociation":{ - "type":"structure", - "members":{ - "PublicIp":{ - "shape":"String", - "documentation":"The public IP address or Elastic IP address bound to the network interface.
", - "locationName":"publicIp" - }, - "PublicDnsName":{ - "shape":"String", - "documentation":"The public DNS name.
", - "locationName":"publicDnsName" - }, - "IpOwnerId":{ - "shape":"String", - "documentation":"The ID of the owner of the Elastic IP address.
", - "locationName":"ipOwnerId" - } - }, - "documentation":"Describes association information for an Elastic IP address.
" - }, - "InstanceNetworkInterfaceAttachment":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The index of the device on the instance for the network interface attachment.
", - "locationName":"deviceIndex" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"The attachment state.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is deleted when the instance is terminated.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes a network interface attachment.
" - }, - "InstanceNetworkInterfaceList":{ - "type":"list", - "member":{ - "shape":"InstanceNetworkInterface", - "locationName":"item" - } - }, - "InstanceNetworkInterfaceSpecification":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
", - "locationName":"deviceIndex" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
", - "locationName":"subnetId" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the network interface. Applies only if creating a network interface when launching an instance.
", - "locationName":"description" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address of the network interface. Applies only if creating a network interface when launching an instance.
", - "locationName":"privateIpAddress" - }, - "Groups":{ - "shape":"SecurityGroupIdStringList", - "documentation":"The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
", - "locationName":"SecurityGroupId" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.
", - "locationName":"privateIpAddressesSet", - "queryName":"PrivateIpAddresses" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.
", - "locationName":"secondaryPrivateIpAddressCount" - }, - "AssociatePublicIpAddress":{ - "shape":"Boolean", - "documentation":"Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If luanching into a default subnet, the default value is true.
Describes a network interface.
" - }, - "InstanceNetworkInterfaceSpecificationList":{ - "type":"list", - "member":{ - "shape":"InstanceNetworkInterfaceSpecification", - "locationName":"item" - } - }, - "InstancePrivateIpAddress":{ - "type":"structure", - "members":{ - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address of the network interface.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "Primary":{ - "shape":"Boolean", - "documentation":"Indicates whether this IP address is the primary private IP address of the network interface.
", - "locationName":"primary" - }, - "Association":{ - "shape":"InstanceNetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP address for the network interface.
", - "locationName":"association" - } - }, - "documentation":"Describes a private IP address.
" - }, - "InstancePrivateIpAddressList":{ - "type":"list", - "member":{ - "shape":"InstancePrivateIpAddress", - "locationName":"item" - } - }, - "InstanceState":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"Integer", - "documentation":"The low byte represents the state. The high byte is an opaque internal value and should be ignored.
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
", - "locationName":"name" - } - }, - "documentation":"Describes the current state of the instance.
" - }, - "InstanceStateChange":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "CurrentState":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
", - "locationName":"currentState" - }, - "PreviousState":{ - "shape":"InstanceState", - "documentation":"The previous state of the instance.
", - "locationName":"previousState" - } - }, - "documentation":"Describes an instance state change.
" - }, - "InstanceStateChangeList":{ - "type":"list", - "member":{ - "shape":"InstanceStateChange", - "locationName":"item" - } - }, - "InstanceStateName":{ - "type":"string", - "enum":[ - "pending", - "running", - "shutting-down", - "terminated", - "stopping", - "stopped" - ] - }, - "InstanceStatus":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the instance.
", - "locationName":"availabilityZone" - }, - "Events":{ - "shape":"InstanceStatusEventList", - "documentation":"Extra information regarding events associated with the instance.
", - "locationName":"eventsSet" - }, - "InstanceState":{ - "shape":"InstanceState", - "documentation":"The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
", - "locationName":"systemStatus" - }, - "InstanceStatus":{ - "shape":"InstanceStatusSummary", - "documentation":"Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
", - "locationName":"instanceStatus" - } - }, - "documentation":"Describes the status of an instance.
" - }, - "InstanceStatusDetails":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"StatusName", - "documentation":"The type of instance status.
", - "locationName":"name" - }, - "Status":{ - "shape":"StatusType", - "documentation":"The status.
", - "locationName":"status" - }, - "ImpairedSince":{ - "shape":"DateTime", - "documentation":"The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
", - "locationName":"impairedSince" - } - }, - "documentation":"Describes the instance status.
" - }, - "InstanceStatusDetailsList":{ - "type":"list", - "member":{ - "shape":"InstanceStatusDetails", - "locationName":"item" - } - }, - "InstanceStatusEvent":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"EventCode", - "documentation":"The associated code of the event.
", - "locationName":"code" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the event.
", - "locationName":"description" - }, - "NotBefore":{ - "shape":"DateTime", - "documentation":"The earliest scheduled start time for the event.
", - "locationName":"notBefore" - }, - "NotAfter":{ - "shape":"DateTime", - "documentation":"The latest scheduled end time for the event.
", - "locationName":"notAfter" - } - }, - "documentation":"Describes an instance event.
" - }, - "InstanceStatusEventList":{ - "type":"list", - "member":{ - "shape":"InstanceStatusEvent", - "locationName":"item" - } - }, - "InstanceStatusList":{ - "type":"list", - "member":{ - "shape":"InstanceStatus", - "locationName":"item" - } - }, - "InstanceStatusSummary":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"SummaryStatus", - "documentation":"The status.
", - "locationName":"status" - }, - "Details":{ - "shape":"InstanceStatusDetailsList", - "documentation":"The system instance health or application instance health.
", - "locationName":"details" - } - }, - "documentation":"Describes the status of an instance.
" - }, - "InstanceType":{ - "type":"string", - "enum":[ - "t1.micro", - "m1.small", - "m1.medium", - "m1.large", - "m1.xlarge", - "m3.medium", - "m3.large", - "m3.xlarge", - "m3.2xlarge", - "t2.micro", - "t2.small", - "t2.medium", - "m2.xlarge", - "m2.2xlarge", - "m2.4xlarge", - "cr1.8xlarge", - "i2.xlarge", - "i2.2xlarge", - "i2.4xlarge", - "i2.8xlarge", - "hi1.4xlarge", - "hs1.8xlarge", - "c1.medium", - "c1.xlarge", - "c3.large", - "c3.xlarge", - "c3.2xlarge", - "c3.4xlarge", - "c3.8xlarge", - "cc1.4xlarge", - "cc2.8xlarge", - "g2.2xlarge", - "cg1.4xlarge", - "r3.large", - "r3.xlarge", - "r3.2xlarge", - "r3.4xlarge", - "r3.8xlarge" - ] - }, - "InstanceTypeList":{ - "type":"list", - "member":{"shape":"InstanceType"} - }, - "Integer":{"type":"integer"}, - "InternetGateway":{ - "type":"structure", - "members":{ - "InternetGatewayId":{ - "shape":"String", - "documentation":"The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - }, - "Attachments":{ - "shape":"InternetGatewayAttachmentList", - "documentation":"Any VPCs attached to the Internet gateway.
", - "locationName":"attachmentSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the Internet gateway.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes an Internet gateway.
" - }, - "InternetGatewayAttachment":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "State":{ - "shape":"AttachmentStatus", - "documentation":"The current state of the attachment.
", - "locationName":"state" - } - }, - "documentation":"Describes the attachment of a VPC to an Internet gateway.
" - }, - "InternetGatewayAttachmentList":{ - "type":"list", - "member":{ - "shape":"InternetGatewayAttachment", - "locationName":"item" - } - }, - "InternetGatewayList":{ - "type":"list", - "member":{ - "shape":"InternetGateway", - "locationName":"item" - } - }, - "IpPermission":{ - "type":"structure", - "members":{ - "IpProtocol":{ - "shape":"String", - "documentation":"The protocol.
When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
One or more security group and AWS account ID pairs.
", - "locationName":"groups" - }, - "IpRanges":{ - "shape":"IpRangeList", - "documentation":"One or more IP ranges.
", - "locationName":"ipRanges" - } - }, - "documentation":"Describes a security group rule.
" - }, - "IpPermissionList":{ - "type":"list", - "member":{ - "shape":"IpPermission", - "locationName":"item" - } - }, - "IpRange":{ - "type":"structure", - "members":{ - "CidrIp":{ - "shape":"String", - "documentation":"The CIDR range. You can either specify a CIDR range or a source security group, not both.
", - "locationName":"cidrIp" - } - }, - "documentation":"Describes an IP range.
" - }, - "IpRangeList":{ - "type":"list", - "member":{ - "shape":"IpRange", - "locationName":"item" - } - }, - "KeyNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"KeyName" - } - }, - "KeyPair":{ - "type":"structure", - "members":{ - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"The SHA-1 digest of the DER encoded private key.
", - "locationName":"keyFingerprint" - }, - "KeyMaterial":{ - "shape":"String", - "documentation":"An unencrypted PEM encoded RSA private key.
", - "locationName":"keyMaterial" - } - }, - "documentation":"Describes a key pair.
" - }, - "KeyPairInfo":{ - "type":"structure", - "members":{ - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
", - "locationName":"keyFingerprint" - } - }, - "documentation":"Describes a key pair.
" - }, - "KeyPairList":{ - "type":"list", - "member":{ - "shape":"KeyPairInfo", - "locationName":"item" - } - }, - "LaunchPermission":{ - "type":"structure", - "members":{ - "UserId":{ - "shape":"String", - "documentation":"The AWS account ID.
", - "locationName":"userId" - }, - "Group":{ - "shape":"PermissionGroup", - "documentation":"The name of the group.
", - "locationName":"group" - } - }, - "documentation":"Describes a launch permission.
" - }, - "LaunchPermissionList":{ - "type":"list", - "member":{ - "shape":"LaunchPermission", - "locationName":"item" - } - }, - "LaunchPermissionModifications":{ - "type":"structure", - "members":{ - "Add":{ - "shape":"LaunchPermissionList", - "documentation":"The AWS account ID to add to the list of launch permissions for the AMI.
" - }, - "Remove":{ - "shape":"LaunchPermissionList", - "documentation":"The AWS account ID to remove from the list of launch permissions for the AMI.
" - } - }, - "documentation":"Describes a launch permission modification.
" - }, - "LaunchSpecification":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "SecurityGroups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups. If requesting a Spot Instance in a nondefault VPC, you must specify the security group ID. If requesting a Spot Instance in EC2-Classic or a default VPC, you can specify either the security group name or ID.
", - "locationName":"groupSet" - }, - "UserData":{ - "shape":"String", - "documentation":"The Base64-encoded MIME user data to make available to the instances.
", - "locationName":"userData" - }, - "AddressingType":{ - "shape":"String", - "documentation":"Deprecated.
", - "locationName":"addressingType" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
Default: m1.small
The placement information for the instance.
", - "locationName":"placement" - }, - "KernelId":{ - "shape":"String", - "documentation":"The ID of the kernel.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The ID of the RAM disk.
", - "locationName":"ramdiskId" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"One or more block device mapping entries.
", - "locationName":"blockDeviceMapping" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which to launch the Spot Instance.
", - "locationName":"subnetId" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceSpecificationList", - "documentation":"One or more network interfaces.
", - "locationName":"networkInterfaceSet" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfileSpecification", - "documentation":"The IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Describes the launch specification of a Spot Instance.
" - }, - "ListingState":{ - "type":"string", - "enum":[ - "available", - "sold", - "cancelled", - "pending" - ] - }, - "ListingStatus":{ - "type":"string", - "enum":[ - "active", - "pending", - "cancelled", - "closed" - ] - }, - "Long":{"type":"long"}, - "ModifyImageAttributeRequest":{ - "type":"structure", - "required":["ImageId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - }, - "Attribute":{ - "shape":"String", - "documentation":"The name of the attribute to modify.
" - }, - "OperationType":{ - "shape":"String", - "documentation":"The operation type.
" - }, - "UserIds":{ - "shape":"UserIdStringList", - "documentation":"One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
One or more user groups. This is only valid when modifying the launchPermission attribute.
One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
The value of the attribute being modified. This is only valid when modifying the description attribute.
A description for the AMI.
" - } - } - }, - "ModifyInstanceAttributeRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The name of the attribute.
", - "locationName":"attribute" - }, - "Value":{ - "shape":"String", - "documentation":"A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
", - "locationName":"blockDeviceMapping" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", - "locationName":"kernel" - }, - "Ramdisk":{ - "shape":"AttributeValue", - "documentation":"Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", - "locationName":"ramdisk" - }, - "UserData":{ - "shape":"BlobAttributeValue", - "documentation":"Changes the instance's user data to the specified value.
", - "locationName":"userData" - }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"AttributeValue", - "documentation":"Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, - "Groups":{ - "shape":"GroupIdStringList", - "documentation":"[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
For example, if you want the instance to be in sg-1a1a1a1a and sg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and GroupId.2=sg-9b9b9b9b.
Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", - "locationName":"ebsOptimized" - }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "documentation":"Set to simple to enable enhanced networking for the instance.
There is no way to disable enhanced networking at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", - "locationName":"sriovNetSupport" - } - } - }, - "ModifyNetworkInterfaceAttributeRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "Description":{ - "shape":"AttributeValue", - "documentation":"A description for the network interface.
", - "locationName":"description" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", - "locationName":"SecurityGroupId" - }, - "Attachment":{ - "shape":"NetworkInterfaceAttachmentChanges", - "documentation":"Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
", - "locationName":"attachment" - } - } - }, - "ModifyReservedInstancesRequest":{ - "type":"structure", - "required":[ - "ReservedInstancesIds", - "TargetConfigurations" - ], - "members":{ - "ClientToken":{ - "shape":"String", - "documentation":"A unique, case-sensitive token you provide to ensure idempotency of your modification request.
", - "locationName":"clientToken" - }, - "ReservedInstancesIds":{ - "shape":"ReservedInstancesIdStringList", - "documentation":"The IDs of the Reserved Instances to modify.
", - "locationName":"ReservedInstancesId" - }, - "TargetConfigurations":{ - "shape":"ReservedInstancesConfigurationList", - "documentation":"The configuration settings for the Reserved Instances to modify.
", - "locationName":"ReservedInstancesConfigurationSetItemType" - } - } - }, - "ModifyReservedInstancesResult":{ - "type":"structure", - "members":{ - "ReservedInstancesModificationId":{ - "shape":"String", - "documentation":"The ID for the modification.
", - "locationName":"reservedInstancesModificationId" - } - } - }, - "ModifySnapshotAttributeRequest":{ - "type":"structure", - "required":["SnapshotId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot.
" - }, - "Attribute":{ - "shape":"SnapshotAttributeName", - "documentation":"The snapshot attribute to modify.
" - }, - "OperationType":{ - "shape":"String", - "documentation":"The type of operation to perform to the attribute.
" - }, - "UserIds":{ - "shape":"UserIdStringList", - "documentation":"The account ID to modify for the snapshot.
", - "locationName":"UserId" - }, - "GroupNames":{ - "shape":"GroupNameStringList", - "documentation":"The group to modify for the snapshot.
", - "locationName":"UserGroup" - }, - "CreateVolumePermission":{ - "shape":"CreateVolumePermissionModifications", - "documentation":"A JSON representation of the snapshot attribute modification.
" - } - } - }, - "ModifySubnetAttributeRequest":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "MapPublicIpOnLaunch":{"shape":"AttributeBooleanValue"} - } - }, - "ModifyVolumeAttributeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
" - }, - "AutoEnableIO":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the volume should be auto-enabled for I/O operations.
" - } - } - }, - "ModifyVpcAttributeRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "EnableDnsSupport":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
" - }, - "EnableDnsHostnames":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You can only enable DNS hostnames if you also enable DNS support.
" - } - } - }, - "MonitorInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "MonitorInstancesResult":{ - "type":"structure", - "members":{ - "InstanceMonitorings":{ - "shape":"InstanceMonitoringList", - "documentation":"Monitoring information for one or more instances.
", - "locationName":"instancesSet" - } - } - }, - "Monitoring":{ - "type":"structure", - "members":{ - "State":{ - "shape":"MonitoringState", - "documentation":"Indicates whether monitoring is enabled for the instance.
", - "locationName":"state" - } - }, - "documentation":"Describes the monitoring for the instance.
" - }, - "MonitoringState":{ - "type":"string", - "enum":[ - "disabled", - "enabled", - "pending" - ] - }, - "NetworkAcl":{ - "type":"structure", - "members":{ - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC for the network ACL.
", - "locationName":"vpcId" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the default network ACL for the VPC.
", - "locationName":"default" - }, - "Entries":{ - "shape":"NetworkAclEntryList", - "documentation":"One or more entries (rules) in the network ACL.
", - "locationName":"entrySet" - }, - "Associations":{ - "shape":"NetworkAclAssociationList", - "documentation":"Any associations between the network ACL and one or more subnets
", - "locationName":"associationSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the network ACL.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a network ACL.
" - }, - "NetworkAclAssociation":{ - "type":"structure", - "members":{ - "NetworkAclAssociationId":{ - "shape":"String", - "documentation":"The ID of the association between a network ACL and a subnet.
", - "locationName":"networkAclAssociationId" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - } - }, - "documentation":"Describes an association between a network ACL and a subnet.
" - }, - "NetworkAclAssociationList":{ - "type":"list", - "member":{ - "shape":"NetworkAclAssociation", - "locationName":"item" - } - }, - "NetworkAclEntry":{ - "type":"structure", - "members":{ - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number for the entry. ACL entries are processed in ascending order by rule number.
", - "locationName":"ruleNumber" - }, - "Protocol":{ - "shape":"String", - "documentation":"The protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
", - "locationName":"ruleAction" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
", - "locationName":"egress" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range to allow or deny, in CIDR notation.
", - "locationName":"cidrBlock" - }, - "IcmpTypeCode":{ - "shape":"IcmpTypeCode", - "documentation":"ICMP protocol: The ICMP type and code.
", - "locationName":"icmpTypeCode" - }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to.
", - "locationName":"portRange" - } - }, - "documentation":"Describes an entry in a network ACL.
" - }, - "NetworkAclEntryList":{ - "type":"list", - "member":{ - "shape":"NetworkAclEntry", - "locationName":"item" - } - }, - "NetworkAclList":{ - "type":"list", - "member":{ - "shape":"NetworkAcl", - "locationName":"item" - } - }, - "NetworkInterface":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone.
", - "locationName":"availabilityZone" - }, - "Description":{ - "shape":"String", - "documentation":"A description.
", - "locationName":"description" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the network interface.
", - "locationName":"ownerId" - }, - "RequesterId":{ - "shape":"String", - "documentation":"The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
", - "locationName":"requesterId" - }, - "RequesterManaged":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is being managed by AWS.
", - "locationName":"requesterManaged" - }, - "Status":{ - "shape":"NetworkInterfaceStatus", - "documentation":"The status of the network interface.
", - "locationName":"status" - }, - "MacAddress":{ - "shape":"String", - "documentation":"The MAC address.
", - "locationName":"macAddress" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The IP address of the network interface within the subnet.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "SourceDestCheck":{ - "shape":"Boolean", - "documentation":"Indicates whether traffic to or from the instance is validated.
", - "locationName":"sourceDestCheck" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"Any security groups for the network interface.
", - "locationName":"groupSet" - }, - "Attachment":{ - "shape":"NetworkInterfaceAttachment", - "documentation":"The network interface attachment.
", - "locationName":"attachment" - }, - "Association":{ - "shape":"NetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP associated with the network interface.
", - "locationName":"association" - }, - "TagSet":{ - "shape":"TagList", - "documentation":"Any tags assigned to the network interface.
", - "locationName":"tagSet" - }, - "PrivateIpAddresses":{ - "shape":"NetworkInterfacePrivateIpAddressList", - "documentation":"The private IP addresses associated with the network interface.
", - "locationName":"privateIpAddressesSet" - } - }, - "documentation":"Describes a network interface.
" - }, - "NetworkInterfaceAssociation":{ - "type":"structure", - "members":{ - "PublicIp":{ - "shape":"String", - "documentation":"The address of the Elastic IP address bound to the network interface.
", - "locationName":"publicIp" - }, - "PublicDnsName":{ - "shape":"String", - "documentation":"The public DNS name.
", - "locationName":"publicDnsName" - }, - "IpOwnerId":{ - "shape":"String", - "documentation":"The ID of the Elastic IP address owner.
", - "locationName":"ipOwnerId" - }, - "AllocationId":{ - "shape":"String", - "documentation":"The allocation ID.
", - "locationName":"allocationId" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The association ID.
", - "locationName":"associationId" - } - }, - "documentation":"Describes association information for an Elastic IP address.
" - }, - "NetworkInterfaceAttachment":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "InstanceOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the instance.
", - "locationName":"instanceOwnerId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The device index of the network interface attachment on the instance.
", - "locationName":"deviceIndex" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"The attachment state.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The timestamp indicating when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is deleted when the instance is terminated.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes a network interface attachment.
" - }, - "NetworkInterfaceAttachmentChanges":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is deleted when the instance is terminated.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes an attachment change.
" - }, - "NetworkInterfaceAttribute":{ - "type":"string", - "enum":[ - "description", - "groupSet", - "sourceDestCheck", - "attachment" - ] - }, - "NetworkInterfaceIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"item" - } - }, - "NetworkInterfaceList":{ - "type":"list", - "member":{ - "shape":"NetworkInterface", - "locationName":"item" - } - }, - "NetworkInterfacePrivateIpAddress":{ - "type":"structure", - "members":{ - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "Primary":{ - "shape":"Boolean", - "documentation":"Indicates whether this IP address is the primary private IP address of the network interface.
", - "locationName":"primary" - }, - "Association":{ - "shape":"NetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP address associated with the network interface.
", - "locationName":"association" - } - }, - "documentation":"Describes the private IP address of a network interface.
" - }, - "NetworkInterfacePrivateIpAddressList":{ - "type":"list", - "member":{ - "shape":"NetworkInterfacePrivateIpAddress", - "locationName":"item" - } - }, - "NetworkInterfaceStatus":{ - "type":"string", - "enum":[ - "available", - "attaching", - "in-use", - "detaching" - ] - }, - "OfferingTypeValues":{ - "type":"string", - "enum":[ - "Heavy Utilization", - "Medium Utilization", - "Light Utilization" - ] - }, - "OwnerStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"Owner" - } - }, - "PermissionGroup":{ - "type":"string", - "enum":["all"] - }, - "Placement":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the instance.
", - "locationName":"availabilityZone" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group the instance is in (for cluster compute instances).
", - "locationName":"groupName" - }, - "Tenancy":{ - "shape":"Tenancy", - "documentation":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
Describes the placement for the instance.
" - }, - "PlacementGroup":{ - "type":"structure", - "members":{ - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group.
", - "locationName":"groupName" - }, - "Strategy":{ - "shape":"PlacementStrategy", - "documentation":"The placement strategy.
", - "locationName":"strategy" - }, - "State":{ - "shape":"PlacementGroupState", - "documentation":"The state of the placement group.
", - "locationName":"state" - } - }, - "documentation":"Describes a placement group.
" - }, - "PlacementGroupList":{ - "type":"list", - "member":{ - "shape":"PlacementGroup", - "locationName":"item" - } - }, - "PlacementGroupState":{ - "type":"string", - "enum":[ - "pending", - "available", - "deleting", - "deleted" - ] - }, - "PlacementGroupStringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PlacementStrategy":{ - "type":"string", - "enum":["cluster"] - }, - "PlatformValues":{ - "type":"string", - "enum":["Windows"] - }, - "PortRange":{ - "type":"structure", - "members":{ - "From":{ - "shape":"Integer", - "documentation":"The first port in the range.
", - "locationName":"from" - }, - "To":{ - "shape":"Integer", - "documentation":"The last port in the range.
", - "locationName":"to" - } - }, - "documentation":"Describes a range of ports.
" - }, - "PriceSchedule":{ - "type":"structure", - "members":{ - "Term":{ - "shape":"Long", - "documentation":"The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", - "locationName":"term" - }, - "Price":{ - "shape":"Double", - "documentation":"The fixed price for the term.
", - "locationName":"price" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
", - "locationName":"active" - } - }, - "documentation":"Describes the price for a Reserved Instance.
" - }, - "PriceScheduleList":{ - "type":"list", - "member":{ - "shape":"PriceSchedule", - "locationName":"item" - } - }, - "PriceScheduleSpecification":{ - "type":"structure", - "members":{ - "Term":{ - "shape":"Long", - "documentation":"The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", - "locationName":"term" - }, - "Price":{ - "shape":"Double", - "documentation":"The fixed price for the term.
", - "locationName":"price" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
Describes the price for a Reserved Instance.
" - }, - "PriceScheduleSpecificationList":{ - "type":"list", - "member":{ - "shape":"PriceScheduleSpecification", - "locationName":"item" - } - }, - "PricingDetail":{ - "type":"structure", - "members":{ - "Price":{ - "shape":"Double", - "documentation":"The price per instance.
", - "locationName":"price" - }, - "Count":{ - "shape":"Integer", - "documentation":"The number of instances available for the price.
", - "locationName":"count" - } - }, - "documentation":"Describes a Reserved Instance offering.
" - }, - "PricingDetailsList":{ - "type":"list", - "member":{ - "shape":"PricingDetail", - "locationName":"item" - } - }, - "PrivateIpAddressSpecification":{ - "type":"structure", - "required":["PrivateIpAddress"], - "members":{ - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP addresses.
", - "locationName":"privateIpAddress" - }, - "Primary":{ - "shape":"Boolean", - "documentation":"Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
", - "locationName":"primary" - } - }, - "documentation":"Describes a secondary private IP address for a network interface.
" - }, - "PrivateIpAddressSpecificationList":{ - "type":"list", - "member":{ - "shape":"PrivateIpAddressSpecification", - "locationName":"item" - } - }, - "PrivateIpAddressStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"PrivateIpAddress" - } - }, - "ProductCode":{ - "type":"structure", - "members":{ - "ProductCodeId":{ - "shape":"String", - "documentation":"The product code.
", - "locationName":"productCode" - }, - "ProductCodeType":{ - "shape":"ProductCodeValues", - "documentation":"The type of product code.
", - "locationName":"type" - } - }, - "documentation":"Describes a product code.
" - }, - "ProductCodeList":{ - "type":"list", - "member":{ - "shape":"ProductCode", - "locationName":"item" - } - }, - "ProductCodeStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ProductCode" - } - }, - "ProductCodeValues":{ - "type":"string", - "enum":[ - "devpay", - "marketplace" - ] - }, - "ProductDescriptionList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PropagatingVgw":{ - "type":"structure", - "members":{ - "GatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway (VGW).
", - "locationName":"gatewayId" - } - }, - "documentation":"Describes a virtual private gateway propagating route.
" - }, - "PropagatingVgwList":{ - "type":"list", - "member":{ - "shape":"PropagatingVgw", - "locationName":"item" - } - }, - "PublicIpStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"PublicIp" - } - }, - "PurchaseReservedInstancesOfferingRequest":{ - "type":"structure", - "required":[ - "ReservedInstancesOfferingId", - "InstanceCount" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ReservedInstancesOfferingId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance offering to purchase.
" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of Reserved Instances to purchase.
" - }, - "LimitPrice":{ - "shape":"ReservedInstanceLimitPrice", - "documentation":"Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
", - "locationName":"limitPrice" - } - } - }, - "PurchaseReservedInstancesOfferingResult":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The IDs of the purchased Reserved Instances.
", - "locationName":"reservedInstancesId" - } - } - }, - "RIProductDescription":{ - "type":"string", - "enum":[ - "Linux/UNIX", - "Linux/UNIX (Amazon VPC)", - "Windows", - "Windows (Amazon VPC)" - ] - }, - "ReasonCodesList":{ - "type":"list", - "member":{ - "shape":"ReportInstanceReasonCodes", - "locationName":"item" - } - }, - "RebootInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "RecurringCharge":{ - "type":"structure", - "members":{ - "Frequency":{ - "shape":"RecurringChargeFrequency", - "documentation":"The frequency of the recurring charge.
", - "locationName":"frequency" - }, - "Amount":{ - "shape":"Double", - "documentation":"The amount of the recurring charge.
", - "locationName":"amount" - } - }, - "documentation":"Describes a recurring charge.
" - }, - "RecurringChargeFrequency":{ - "type":"string", - "enum":["Hourly"] - }, - "RecurringChargesList":{ - "type":"list", - "member":{ - "shape":"RecurringCharge", - "locationName":"item" - } - }, - "Region":{ - "type":"structure", - "members":{ - "RegionName":{ - "shape":"String", - "documentation":"The name of the region.
", - "locationName":"regionName" - }, - "Endpoint":{ - "shape":"String", - "documentation":"The region service endpoint.
", - "locationName":"regionEndpoint" - } - }, - "documentation":"Describes a region.
" - }, - "RegionList":{ - "type":"list", - "member":{ - "shape":"Region", - "locationName":"item" - } - }, - "RegionNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"RegionName" - } - }, - "RegisterImageRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageLocation":{ - "shape":"String", - "documentation":"The full path to your AMI manifest in Amazon S3 storage.
" - }, - "Name":{ - "shape":"String", - "documentation":"A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", - "locationName":"name" - }, - "Description":{ - "shape":"String", - "documentation":"A description for your AMI.
", - "locationName":"description" - }, - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The ID of the kernel.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The ID of the RAM disk.
", - "locationName":"ramdiskId" - }, - "RootDeviceName":{ - "shape":"String", - "documentation":"The name of the root device (for example, /dev/sda1, or xvda).
One or more block device mapping entries.
", - "locationName":"BlockDeviceMapping" - }, - "VirtualizationType":{ - "shape":"String", - "documentation":"The type of virtualization.
Default: paravirtual
Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.
There is no way to disable enhanced networking at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", - "locationName":"sriovNetSupport" - } - } - }, - "RegisterImageResult":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the newly registered AMI.
", - "locationName":"imageId" - } - } - }, - "RejectVpcPeeringConnectionRequest":{ - "type":"structure", - "required":["VpcPeeringConnectionId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "RejectVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" - }, - "AllocationId":{ - "shape":"String", - "documentation":"[EC2-VPC] The allocation ID. Required for EC2-VPC.
" - } - } - }, - "ReplaceNetworkAclAssociationRequest":{ - "type":"structure", - "required":[ - "AssociationId", - "NetworkAclId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The ID of the current association between the original network ACL and the subnet.
", - "locationName":"associationId" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the new network ACL to associate with the subnet.
", - "locationName":"networkAclId" - } - } - }, - "ReplaceNetworkAclAssociationResult":{ - "type":"structure", - "members":{ - "NewAssociationId":{ - "shape":"String", - "documentation":"The ID of the new association.
", - "locationName":"newAssociationId" - } - } - }, - "ReplaceNetworkAclEntryRequest":{ - "type":"structure", - "required":[ - "NetworkAclId", - "RuleNumber", - "Protocol", - "RuleAction", - "Egress", - "CidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the ACL.
", - "locationName":"networkAclId" - }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number of the entry to replace.
", - "locationName":"ruleNumber" - }, - "Protocol":{ - "shape":"String", - "documentation":"The IP protocol. You can specify all or -1 to mean all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
", - "locationName":"ruleAction" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
", - "locationName":"egress" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range to allow or deny, in CIDR notation.
", - "locationName":"cidrBlock" - }, - "IcmpTypeCode":{ - "shape":"IcmpTypeCode", - "documentation":"ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.
", - "locationName":"Icmp" - }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.
", - "locationName":"portRange" - } - } - }, - "ReplaceRouteRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "DestinationCidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.
", - "locationName":"destinationCidrBlock" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of an Internet gateway or virtual private gateway.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of a NAT instance in your VPC.
", - "locationName":"instanceId" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of a network interface.
", - "locationName":"networkInterfaceId" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of a VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "ReplaceRouteTableAssociationRequest":{ - "type":"structure", - "required":[ - "AssociationId", - "RouteTableId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The association ID.
", - "locationName":"associationId" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the new route table to associate with the subnet.
", - "locationName":"routeTableId" - } - } - }, - "ReplaceRouteTableAssociationResult":{ - "type":"structure", - "members":{ - "NewAssociationId":{ - "shape":"String", - "documentation":"The ID of the new association.
", - "locationName":"newAssociationId" - } - } - }, - "ReportInstanceReasonCodes":{ - "type":"string", - "enum":[ - "instance-stuck-in-state", - "unresponsive", - "not-accepting-credentials", - "password-not-available", - "performance-network", - "performance-instance-store", - "performance-ebs-volume", - "performance-other", - "other" - ] - }, - "ReportInstanceStatusRequest":{ - "type":"structure", - "required":[ - "Instances", - "Status", - "ReasonCodes" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Instances":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instances.
", - "locationName":"instanceId" - }, - "Status":{ - "shape":"ReportStatusType", - "documentation":"The status of all instances listed.
", - "locationName":"status" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time at which the reported instance health state began.
", - "locationName":"startTime" - }, - "EndTime":{ - "shape":"DateTime", - "documentation":"The time at which the reported instance health state ended.
", - "locationName":"endTime" - }, - "ReasonCodes":{ - "shape":"ReasonCodesList", - "documentation":"One or more reason codes that describes the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems which I believe are network related.
performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Descriptive text about the health state of your instance.
", - "locationName":"description" - } - } - }, - "ReportStatusType":{ - "type":"string", - "enum":[ - "ok", - "impaired" - ] - }, - "RequestSpotInstancesRequest":{ - "type":"structure", - "required":["SpotPrice"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SpotPrice":{ - "shape":"String", - "documentation":"The maximum hourly price for any Spot Instance launched to fulfill the request.
", - "locationName":"spotPrice" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The maximum number of Spot Instances to launch.
Default: 1
", - "locationName":"instanceCount" - }, - "Type":{ - "shape":"SpotInstanceType", - "documentation":"The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
Default: The request is effective indefinitely.
", - "locationName":"validFrom" - }, - "ValidUntil":{ - "shape":"DateTime", - "documentation":"The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
Default: The request is effective indefinitely.
", - "locationName":"validUntil" - }, - "LaunchGroup":{ - "shape":"String", - "documentation":"The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
", - "locationName":"launchGroup" - }, - "AvailabilityZoneGroup":{ - "shape":"String", - "documentation":"The user-specified name for a logical grouping of bids.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
", - "locationName":"availabilityZoneGroup" - }, - "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} - } - }, - "RequestSpotInstancesResult":{ - "type":"structure", - "members":{ - "SpotInstanceRequests":{ - "shape":"SpotInstanceRequestList", - "documentation":"Information about the Spot Instance request.
", - "locationName":"spotInstanceRequestSet" - } - } - }, - "Reservation":{ - "type":"structure", - "members":{ - "ReservationId":{ - "shape":"String", - "documentation":"The ID of the reservation.
", - "locationName":"reservationId" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The ID of the AWS account that owns the reservation.
", - "locationName":"ownerId" - }, - "RequesterId":{ - "shape":"String", - "documentation":"The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
", - "locationName":"requesterId" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups.
", - "locationName":"groupSet" - }, - "Instances":{ - "shape":"InstanceList", - "documentation":"One or more instances.
", - "locationName":"instancesSet" - } - }, - "documentation":"Describes a reservation.
" - }, - "ReservationList":{ - "type":"list", - "member":{ - "shape":"Reservation", - "locationName":"item" - } - }, - "ReservedInstanceLimitPrice":{ - "type":"structure", - "members":{ - "Amount":{ - "shape":"Double", - "documentation":"Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
", - "locationName":"amount" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
Describes the limit price of a Reserved Instance offering.
" - }, - "ReservedInstanceState":{ - "type":"string", - "enum":[ - "payment-pending", - "active", - "payment-failed", - "retired" - ] - }, - "ReservedInstances":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used.
", - "locationName":"instanceType" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
", - "locationName":"availabilityZone" - }, - "Start":{ - "shape":"DateTime", - "documentation":"The date and time the Reserved Instance started.
", - "locationName":"start" - }, - "End":{ - "shape":"DateTime", - "documentation":"The time when the Reserved Instance expires.
", - "locationName":"end" - }, - "Duration":{ - "shape":"Long", - "documentation":"The duration of the Reserved Instance, in seconds.
", - "locationName":"duration" - }, - "UsagePrice":{ - "shape":"Float", - "documentation":"The usage price of the Reserved Instance, per hour.
", - "locationName":"usagePrice" - }, - "FixedPrice":{ - "shape":"Float", - "documentation":"The purchase price of the Reserved Instance.
", - "locationName":"fixedPrice" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of Reserved Instances purchased.
", - "locationName":"instanceCount" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance description.
", - "locationName":"productDescription" - }, - "State":{ - "shape":"ReservedInstanceState", - "documentation":"The state of the Reserved Instance purchase.
", - "locationName":"state" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "InstanceTenancy":{ - "shape":"Tenancy", - "documentation":"The tenancy of the reserved instance.
", - "locationName":"instanceTenancy" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
The Reserved Instance offering type.
", - "locationName":"offeringType" - }, - "RecurringCharges":{ - "shape":"RecurringChargesList", - "documentation":"The recurring charge tag assigned to the resource.
", - "locationName":"recurringCharges" - } - }, - "documentation":"Describes a Reserved Instance.
" - }, - "ReservedInstancesConfiguration":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the modified Reserved Instances.
", - "locationName":"availabilityZone" - }, - "Platform":{ - "shape":"String", - "documentation":"The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
", - "locationName":"platform" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of modified Reserved Instances.
", - "locationName":"instanceCount" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type for the modified Reserved Instances.
", - "locationName":"instanceType" - } - }, - "documentation":"Describes the configuration settings for the modified Reserved Instances.
" - }, - "ReservedInstancesConfigurationList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesConfiguration", - "locationName":"item" - } - }, - "ReservedInstancesId":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - } - }, - "documentation":"Describes the ID of a Reserved Instance.
" - }, - "ReservedInstancesIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ReservedInstancesId" - } - }, - "ReservedInstancesList":{ - "type":"list", - "member":{ - "shape":"ReservedInstances", - "locationName":"item" - } - }, - "ReservedInstancesListing":{ - "type":"structure", - "members":{ - "ReservedInstancesListingId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance listing.
", - "locationName":"reservedInstancesListingId" - }, - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "CreateDate":{ - "shape":"DateTime", - "documentation":"The time the listing was created.
", - "locationName":"createDate" - }, - "UpdateDate":{ - "shape":"DateTime", - "documentation":"The last modified timestamp of the listing.
", - "locationName":"updateDate" - }, - "Status":{ - "shape":"ListingStatus", - "documentation":"The status of the Reserved Instance listing.
", - "locationName":"status" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The reason for the current status of the Reserved Instance listing. The response can be blank.
", - "locationName":"statusMessage" - }, - "InstanceCounts":{ - "shape":"InstanceCountList", - "documentation":"The number of instances in this state.
", - "locationName":"instanceCounts" - }, - "PriceSchedules":{ - "shape":"PriceScheduleList", - "documentation":"The price of the Reserved Instance listing.
", - "locationName":"priceSchedules" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "ClientToken":{ - "shape":"String", - "documentation":"The idempotency token you provided when you created the listing.
", - "locationName":"clientToken" - } - }, - "documentation":"Describes a Reserved Instance listing.
" - }, - "ReservedInstancesListingList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesListing", - "locationName":"item" - } - }, - "ReservedInstancesModification":{ - "type":"structure", - "members":{ - "ReservedInstancesModificationId":{ - "shape":"String", - "documentation":"A unique ID for the Reserved Instance modification.
", - "locationName":"reservedInstancesModificationId" - }, - "ReservedInstancesIds":{ - "shape":"ReservedIntancesIds", - "documentation":"The IDs of one or more Reserved Instances.
", - "locationName":"reservedInstancesSet" - }, - "ModificationResults":{ - "shape":"ReservedInstancesModificationResultList", - "documentation":"Contains target configurations along with their corresponding new Reserved Instance IDs.
", - "locationName":"modificationResultSet" - }, - "CreateDate":{ - "shape":"DateTime", - "documentation":"The time when the modification request was created.
", - "locationName":"createDate" - }, - "UpdateDate":{ - "shape":"DateTime", - "documentation":"The time when the modification request was last updated.
", - "locationName":"updateDate" - }, - "EffectiveDate":{ - "shape":"DateTime", - "documentation":"The time for the modification to become effective.
", - "locationName":"effectiveDate" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the Reserved Instances modification request.
", - "locationName":"status" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The reason for the status.
", - "locationName":"statusMessage" - }, - "ClientToken":{ - "shape":"String", - "documentation":"A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.
", - "locationName":"clientToken" - } - }, - "documentation":"Describes a Reserved Instance modification.
" - }, - "ReservedInstancesModificationIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ReservedInstancesModificationId" - } - }, - "ReservedInstancesModificationList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesModification", - "locationName":"item" - } - }, - "ReservedInstancesModificationResult":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
", - "locationName":"reservedInstancesId" - }, - "TargetConfiguration":{ - "shape":"ReservedInstancesConfiguration", - "documentation":"The target Reserved Instances configurations supplied as part of the modification request.
", - "locationName":"targetConfiguration" - } - } - }, - "ReservedInstancesModificationResultList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesModificationResult", - "locationName":"item" - } - }, - "ReservedInstancesOffering":{ - "type":"structure", - "members":{ - "ReservedInstancesOfferingId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance offering.
", - "locationName":"reservedInstancesOfferingId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used.
", - "locationName":"instanceType" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
", - "locationName":"availabilityZone" - }, - "Duration":{ - "shape":"Long", - "documentation":"The duration of the Reserved Instance, in seconds.
", - "locationName":"duration" - }, - "UsagePrice":{ - "shape":"Float", - "documentation":"The usage price of the Reserved Instance, per hour.
", - "locationName":"usagePrice" - }, - "FixedPrice":{ - "shape":"Float", - "documentation":"The purchase price of the Reserved Instance.
", - "locationName":"fixedPrice" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance description.
", - "locationName":"productDescription" - }, - "InstanceTenancy":{ - "shape":"Tenancy", - "documentation":"The tenancy of the reserved instance.
", - "locationName":"instanceTenancy" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
The Reserved Instance offering type.
", - "locationName":"offeringType" - }, - "RecurringCharges":{ - "shape":"RecurringChargesList", - "documentation":"The recurring charge tag assigned to the resource.
", - "locationName":"recurringCharges" - }, - "Marketplace":{ - "shape":"Boolean", - "documentation":"Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.
The pricing details of the Reserved Instance offering.
", - "locationName":"pricingDetailsSet" - } - }, - "documentation":"Describes a Reserved Instance offering.
" - }, - "ReservedInstancesOfferingIdStringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ReservedInstancesOfferingList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesOffering", - "locationName":"item" - } - }, - "ReservedIntancesIds":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesId", - "locationName":"item" - } - }, - "ResetImageAttributeName":{ - "type":"string", - "enum":["launchPermission"] - }, - "ResetImageAttributeRequest":{ - "type":"structure", - "required":[ - "ImageId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - }, - "Attribute":{ - "shape":"ResetImageAttributeName", - "documentation":"The attribute to reset (currently you can only reset the launch permission attribute).
" - } - } - }, - "ResetInstanceAttributeRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The attribute to reset.
", - "locationName":"attribute" - } - } - }, - "ResetNetworkInterfaceAttributeRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "SourceDestCheck":{ - "shape":"String", - "documentation":"The source/destination checking attribute. Resets the value to true.
The ID of the snapshot.
" - }, - "Attribute":{ - "shape":"SnapshotAttributeName", - "documentation":"The attribute to reset (currently only the attribute for permission to create volumes can be reset).
" - } - } - }, - "ResourceIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ResourceType":{ - "type":"string", - "enum":[ - "customer-gateway", - "dhcp-options", - "image", - "instance", - "internet-gateway", - "network-acl", - "network-interface", - "reserved-instances", - "route-table", - "snapshot", - "spot-instances-request", - "subnet", - "security-group", - "volume", - "vpc", - "vpn-connection", - "vpn-gateway" - ] - }, - "RestorableByStringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "RevokeSecurityGroupEgressRequest":{ - "type":"structure", - "required":["GroupId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupName" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupOwnerId" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
", - "locationName":"cidrIp" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"ipPermissions" - } - } - }, - "RevokeSecurityGroupIngressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the security group.
" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
" - } - } - }, - "Route":{ - "type":"structure", - "members":{ - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block used for the destination match.
", - "locationName":"destinationCidrBlock" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of a gateway attached to your VPC.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of a NAT instance in your VPC.
", - "locationName":"instanceId" - }, - "InstanceOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the instance.
", - "locationName":"instanceOwnerId" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - }, - "State":{ - "shape":"RouteState", - "documentation":"The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
Describes how the route was created.
CreateRouteTable indicates that route was automatically created when the route table was created.CreateRoute indicates that the route was manually added to the route table.EnableVgwRoutePropagation indicates that the route was propagated by route propagation.Describes a route in a route table.
" - }, - "RouteList":{ - "type":"list", - "member":{ - "shape":"Route", - "locationName":"item" - } - }, - "RouteOrigin":{ - "type":"string", - "enum":[ - "CreateRouteTable", - "CreateRoute", - "EnableVgwRoutePropagation" - ] - }, - "RouteState":{ - "type":"string", - "enum":[ - "active", - "blackhole" - ] - }, - "RouteTable":{ - "type":"structure", - "members":{ - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "Routes":{ - "shape":"RouteList", - "documentation":"The routes in the route table.
", - "locationName":"routeSet" - }, - "Associations":{ - "shape":"RouteTableAssociationList", - "documentation":"The associations between the route table and one or more subnets.
", - "locationName":"associationSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the route table.
", - "locationName":"tagSet" - }, - "PropagatingVgws":{ - "shape":"PropagatingVgwList", - "documentation":"Any virtual private gateway (VGW) propagating routes.
", - "locationName":"propagatingVgwSet" - } - }, - "documentation":"Describes a route table.
" - }, - "RouteTableAssociation":{ - "type":"structure", - "members":{ - "RouteTableAssociationId":{ - "shape":"String", - "documentation":"The ID of the association between a route table and a subnet.
", - "locationName":"routeTableAssociationId" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "Main":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the main route table.
", - "locationName":"main" - } - }, - "documentation":"Describes an association between a route table and a subnet.
" - }, - "RouteTableAssociationList":{ - "type":"list", - "member":{ - "shape":"RouteTableAssociation", - "locationName":"item" - } - }, - "RouteTableList":{ - "type":"list", - "member":{ - "shape":"RouteTable", - "locationName":"item" - } - }, - "RuleAction":{ - "type":"string", - "enum":[ - "allow", - "deny" - ] - }, - "RunInstancesMonitoringEnabled":{ - "type":"structure", - "required":["Enabled"], - "members":{ - "Enabled":{ - "shape":"Boolean", - "documentation":"Indicates whether monitoring is enabled for the instance.
", - "locationName":"enabled" - } - }, - "documentation":"Describes the monitoring for the instance.
" - }, - "RunInstancesRequest":{ - "type":"structure", - "required":[ - "ImageId", - "MinCount", - "MaxCount" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI, which you can get by calling DescribeImages.
" - }, - "MinCount":{ - "shape":"Integer", - "documentation":"The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
" - }, - "MaxCount":{ - "shape":"Integer", - "documentation":"The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you launch an instance without specifying a key pair, you can't connect to the instance.
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
Default: Amazon EC2 uses the default security group.
", - "locationName":"SecurityGroup" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIdStringList", - "documentation":"One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
", - "locationName":"SecurityGroupId" - }, - "UserData":{ - "shape":"String", - "documentation":"The Base64-encoded MIME user data for the instances.
" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
The placement for the instance.
" - }, - "KernelId":{ - "shape":"String", - "documentation":"The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
The block device mapping.
", - "locationName":"BlockDeviceMapping" - }, - "Monitoring":{ - "shape":"RunInstancesMonitoringEnabled", - "documentation":"The monitoring for the instance.
" - }, - "SubnetId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the subnet to launch the instance into.
" - }, - "DisableApiTermination":{ - "shape":"Boolean", - "documentation":"If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.
Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.
Default: We select an IP address from the IP address range of the subnet.
", - "locationName":"privateIpAddress" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
Constraints: Maximum 64 ASCII characters
", - "locationName":"clientToken" - }, - "AdditionalInfo":{ - "shape":"String", - "documentation":"Reserved.
", - "locationName":"additionalInfo" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceSpecificationList", - "documentation":"One or more network interfaces.
", - "locationName":"networkInterface" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfileSpecification", - "documentation":"The IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
", - "locationName":"bucket" - }, - "Prefix":{ - "shape":"String", - "documentation":"The beginning of the file name of the AMI.
", - "locationName":"prefix" - }, - "AWSAccessKeyId":{ - "shape":"String", - "documentation":"The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.
" - }, - "UploadPolicy":{ - "shape":"Blob", - "documentation":"A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
", - "locationName":"uploadPolicy" - }, - "UploadPolicySignature":{ - "shape":"String", - "documentation":"The signature of the Base64 encoded JSON document.
", - "locationName":"uploadPolicySignature" - } - }, - "documentation":"Describes the S3 bucket for an instance store-backed AMI.
" - }, - "SecurityGroup":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the security group.
", - "locationName":"ownerId" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
", - "locationName":"groupName" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the security group.
", - "locationName":"groupDescription" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"One or more inbound rules associated with the security group.
", - "locationName":"ipPermissions" - }, - "IpPermissionsEgress":{ - "shape":"IpPermissionList", - "documentation":"[EC2-VPC] One or more outbound rules associated with the security group.
", - "locationName":"ipPermissionsEgress" - }, - "VpcId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the VPC for the security group.
", - "locationName":"vpcId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the security group.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a security group
" - }, - "SecurityGroupIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SecurityGroupId" - } - }, - "SecurityGroupList":{ - "type":"list", - "member":{ - "shape":"SecurityGroup", - "locationName":"item" - } - }, - "SecurityGroupStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SecurityGroup" - } - }, - "ShutdownBehavior":{ - "type":"string", - "enum":[ - "stop", - "terminate" - ] - }, - "Snapshot":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot.
", - "locationName":"snapshotId" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "State":{ - "shape":"SnapshotState", - "documentation":"The snapshot state.
", - "locationName":"status" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the snapshot was initiated.
", - "locationName":"startTime" - }, - "Progress":{ - "shape":"String", - "documentation":"The progress of the snapshot, as a percentage.
", - "locationName":"progress" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the Amazon EBS snapshot owner.
", - "locationName":"ownerId" - }, - "Description":{ - "shape":"String", - "documentation":"The description for the snapshot.
", - "locationName":"description" - }, - "VolumeSize":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiB.
", - "locationName":"volumeSize" - }, - "OwnerAlias":{ - "shape":"String", - "documentation":"The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
Any tags assigned to the snapshot.
", - "locationName":"tagSet" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Indicates whether the snapshot is encrypted.
", - "locationName":"encrypted" - } - }, - "documentation":"Describes a snapshot.
" - }, - "SnapshotAttributeName":{ - "type":"string", - "enum":[ - "productCodes", - "createVolumePermission" - ] - }, - "SnapshotIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SnapshotId" - } - }, - "SnapshotList":{ - "type":"list", - "member":{ - "shape":"Snapshot", - "locationName":"item" - } - }, - "SnapshotState":{ - "type":"string", - "enum":[ - "pending", - "completed", - "error" - ] - }, - "SpotDatafeedSubscription":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the account.
", - "locationName":"ownerId" - }, - "Bucket":{ - "shape":"String", - "documentation":"The Amazon S3 bucket where the Spot Instance datafeed is located.
", - "locationName":"bucket" - }, - "Prefix":{ - "shape":"String", - "documentation":"The prefix that is prepended to datafeed files.
", - "locationName":"prefix" - }, - "State":{ - "shape":"DatafeedSubscriptionState", - "documentation":"The state of the Spot Instance datafeed subscription.
", - "locationName":"state" - }, - "Fault":{ - "shape":"SpotInstanceStateFault", - "documentation":"The fault codes for the Spot Instance request, if any.
", - "locationName":"fault" - } - }, - "documentation":"Describes the datafeed for a Spot Instance.
" - }, - "SpotInstanceRequest":{ - "type":"structure", - "members":{ - "SpotInstanceRequestId":{ - "shape":"String", - "documentation":"The ID of the Spot Instance request.
", - "locationName":"spotInstanceRequestId" - }, - "SpotPrice":{ - "shape":"String", - "documentation":"The maximum hourly price for any Spot Instance launched to fulfill the request.
", - "locationName":"spotPrice" - }, - "Type":{ - "shape":"SpotInstanceType", - "documentation":"The Spot Instance request type.
", - "locationName":"type" - }, - "State":{ - "shape":"SpotInstanceState", - "documentation":"The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
", - "locationName":"state" - }, - "Fault":{ - "shape":"SpotInstanceStateFault", - "documentation":"The fault codes for the Spot Instance request, if any.
", - "locationName":"fault" - }, - "Status":{ - "shape":"SpotInstanceStatus", - "documentation":"The status code and status message describing the Spot Instance request.
", - "locationName":"status" - }, - "ValidFrom":{ - "shape":"DateTime", - "documentation":"The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
", - "locationName":"validFrom" - }, - "ValidUntil":{ - "shape":"DateTime", - "documentation":"The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.
", - "locationName":"validUntil" - }, - "LaunchGroup":{ - "shape":"String", - "documentation":"The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
", - "locationName":"launchGroup" - }, - "AvailabilityZoneGroup":{ - "shape":"String", - "documentation":"The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
", - "locationName":"availabilityZoneGroup" - }, - "LaunchSpecification":{ - "shape":"LaunchSpecification", - "documentation":"Additional information for launching instances.
", - "locationName":"launchSpecification" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID, if an instance has been launched to fulfill the Spot Instance request.
", - "locationName":"instanceId" - }, - "CreateTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the Spot Instance request was created.
", - "locationName":"createTime" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The product description associated with the Spot Instance.
", - "locationName":"productDescription" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "LaunchedAvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the bid is launched.
", - "locationName":"launchedAvailabilityZone" - } - }, - "documentation":"Describe a Spot Instance request.
" - }, - "SpotInstanceRequestIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SpotInstanceRequestId" - } - }, - "SpotInstanceRequestList":{ - "type":"list", - "member":{ - "shape":"SpotInstanceRequest", - "locationName":"item" - } - }, - "SpotInstanceState":{ - "type":"string", - "enum":[ - "open", - "active", - "closed", - "cancelled", - "failed" - ] - }, - "SpotInstanceStateFault":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The reason code for the Spot Instance state change.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"The message for the Spot Instance state change.
", - "locationName":"message" - } - }, - "documentation":"Describes a Spot Instance state change.
" - }, - "SpotInstanceStatus":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The status code of the request.
", - "locationName":"code" - }, - "UpdateTime":{ - "shape":"DateTime", - "documentation":"The time of the most recent status update.
", - "locationName":"updateTime" - }, - "Message":{ - "shape":"String", - "documentation":"The description for the status code for the Spot request.
", - "locationName":"message" - } - }, - "documentation":"Describes a Spot Instance request.
" - }, - "SpotInstanceType":{ - "type":"string", - "enum":[ - "one-time", - "persistent" - ] - }, - "SpotPlacement":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone.
", - "locationName":"availabilityZone" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group (for cluster instances).
", - "locationName":"groupName" - } - }, - "documentation":"Describes Spot Instance placement.
" - }, - "SpotPrice":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"A general description of the AMI.
", - "locationName":"productDescription" - }, - "SpotPrice":{ - "shape":"String", - "documentation":"The maximum price you will pay to launch one or more Spot Instances.
", - "locationName":"spotPrice" - }, - "Timestamp":{ - "shape":"DateTime", - "documentation":"The date and time the request was created.
", - "locationName":"timestamp" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone.
", - "locationName":"availabilityZone" - } - }, - "documentation":"Describes the Spot Price.
" - }, - "SpotPriceHistoryList":{ - "type":"list", - "member":{ - "shape":"SpotPrice", - "locationName":"item" - } - }, - "StartInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - }, - "AdditionalInfo":{ - "shape":"String", - "documentation":"Reserved.
", - "locationName":"additionalInfo" - }, - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "StartInstancesResult":{ - "type":"structure", - "members":{ - "StartingInstances":{ - "shape":"InstanceStateChangeList", - "documentation":"Information about one or more started instances.
", - "locationName":"instancesSet" - } - } - }, - "StateReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The reason code for the state change.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"The message for the state change.
Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
Describes a state change.
" - }, - "StatusName":{ - "type":"string", - "enum":["reachability"] - }, - "StatusType":{ - "type":"string", - "enum":[ - "passed", - "failed", - "insufficient-data" - ] - }, - "StopInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - }, - "Force":{ - "shape":"Boolean", - "documentation":"Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Information about one or more stopped instances.
", - "locationName":"instancesSet" - } - } - }, - "Storage":{ - "type":"structure", - "members":{ - "S3":{ - "shape":"S3Storage", - "documentation":"An Amazon S3 storage location.
" - } - }, - "documentation":"Describes the storage location for an instance store-backed AMI.
" - }, - "String":{"type":"string"}, - "Subnet":{ - "type":"structure", - "members":{ - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "State":{ - "shape":"SubnetState", - "documentation":"The current state of the subnet.
", - "locationName":"state" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC the subnet is in.
", - "locationName":"vpcId" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The CIDR block assigned to the subnet.
", - "locationName":"cidrBlock" - }, - "AvailableIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.
", - "locationName":"availableIpAddressCount" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the subnet.
", - "locationName":"availabilityZone" - }, - "DefaultForAz":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the default subnet for the Availability Zone.
", - "locationName":"defaultForAz" - }, - "MapPublicIpOnLaunch":{ - "shape":"Boolean", - "documentation":"Indicates whether instances launched in this subnet receive a public IP address.
", - "locationName":"mapPublicIpOnLaunch" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the subnet.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a subnet.
" - }, - "SubnetIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SubnetId" - } - }, - "SubnetList":{ - "type":"list", - "member":{ - "shape":"Subnet", - "locationName":"item" - } - }, - "SubnetState":{ - "type":"string", - "enum":[ - "pending", - "available" - ] - }, - "SummaryStatus":{ - "type":"string", - "enum":[ - "ok", - "impaired", - "insufficient-data", - "not-applicable" - ] - }, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
", - "locationName":"value" - } - }, - "documentation":"Describes a tag.
" - }, - "TagDescription":{ - "type":"structure", - "members":{ - "ResourceId":{ - "shape":"String", - "documentation":"The ID of the resource. For example, ami-1a2b3c4d.
The type of resource.
", - "locationName":"resourceType" - }, - "Key":{ - "shape":"String", - "documentation":"The key of the tag.
", - "locationName":"key" - }, - "Value":{ - "shape":"String", - "documentation":"The value of the tag.
", - "locationName":"value" - } - }, - "documentation":"Describes a tag.
" - }, - "TagDescriptionList":{ - "type":"list", - "member":{ - "shape":"TagDescription", - "locationName":"item" - } - }, - "TagList":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"item" - } - }, - "TelemetryStatus":{ - "type":"string", - "enum":[ - "UP", - "DOWN" - ] - }, - "Tenancy":{ - "type":"string", - "enum":[ - "default", - "dedicated" - ] - }, - "TerminateInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "TerminateInstancesResult":{ - "type":"structure", - "members":{ - "TerminatingInstances":{ - "shape":"InstanceStateChangeList", - "documentation":"Information about one or more terminated instances.
", - "locationName":"instancesSet" - } - } - }, - "UnassignPrivateIpAddressesRequest":{ - "type":"structure", - "required":[ - "NetworkInterfaceId", - "PrivateIpAddresses" - ], - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "PrivateIpAddresses":{ - "shape":"PrivateIpAddressStringList", - "documentation":"The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
", - "locationName":"privateIpAddress" - } - } - }, - "UnmonitorInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "UnmonitorInstancesResult":{ - "type":"structure", - "members":{ - "InstanceMonitorings":{ - "shape":"InstanceMonitoringList", - "documentation":"Monitoring information for one or more instances.
", - "locationName":"instancesSet" - } - } - }, - "UserGroupStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"UserGroup" - } - }, - "UserIdGroupPair":{ - "type":"structure", - "members":{ - "UserId":{ - "shape":"String", - "documentation":"The ID of an AWS account.
", - "locationName":"userId" - }, - "GroupName":{ - "shape":"String", - "documentation":"The ID of the security group owned by the specified AWS account.
", - "locationName":"groupName" - }, - "GroupId":{ - "shape":"String", - "documentation":"The name of the security group in the specified AWS account.
", - "locationName":"groupId" - } - }, - "documentation":"Describes a security group and AWS account ID pair for EC2-Classic.
" - }, - "UserIdGroupPairList":{ - "type":"list", - "member":{ - "shape":"UserIdGroupPair", - "locationName":"item" - } - }, - "UserIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"UserId" - } - }, - "ValueStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"item" - } - }, - "VgwTelemetry":{ - "type":"structure", - "members":{ - "OutsideIpAddress":{ - "shape":"String", - "documentation":"The Internet-routable IP address of the virtual private gateway's outside interface.
", - "locationName":"outsideIpAddress" - }, - "Status":{ - "shape":"TelemetryStatus", - "documentation":"The status of the VPN tunnel.
", - "locationName":"status" - }, - "LastStatusChange":{ - "shape":"DateTime", - "documentation":"The date and time of the last change in status.
", - "locationName":"lastStatusChange" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"If an error occurs, a description of the error.
", - "locationName":"statusMessage" - }, - "AcceptedRouteCount":{ - "shape":"Integer", - "documentation":"The number of accepted routes.
", - "locationName":"acceptedRouteCount" - } - }, - "documentation":"Describes telemetry for a VPN tunnel.
" - }, - "VgwTelemetryList":{ - "type":"list", - "member":{ - "shape":"VgwTelemetry", - "locationName":"item" - } - }, - "VirtualizationType":{ - "type":"string", - "enum":[ - "hvm", - "paravirtual" - ] - }, - "Volume":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "Size":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiBs.
", - "locationName":"size" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The snapshot from which the volume was created, if applicable.
", - "locationName":"snapshotId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the volume.
", - "locationName":"availabilityZone" - }, - "State":{ - "shape":"VolumeState", - "documentation":"The volume state.
", - "locationName":"status" - }, - "CreateTime":{ - "shape":"DateTime", - "documentation":"The time stamp when volume creation was initiated.
", - "locationName":"createTime" - }, - "Attachments":{ - "shape":"VolumeAttachmentList", - "locationName":"attachmentSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the volume.
", - "locationName":"tagSet" - }, - "VolumeType":{ - "shape":"VolumeType", - "documentation":"The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
Indicates whether the volume is encrypted.
", - "locationName":"encrypted" - } - }, - "documentation":"Describes a volume.
" - }, - "VolumeAttachment":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Device":{ - "shape":"String", - "documentation":"The device name.
", - "locationName":"device" - }, - "State":{ - "shape":"VolumeAttachmentState", - "documentation":"The attachment state of the volume.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the Amazon EBS volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes volume attachment details.
" - }, - "VolumeAttachmentList":{ - "type":"list", - "member":{ - "shape":"VolumeAttachment", - "locationName":"item" - } - }, - "VolumeAttachmentState":{ - "type":"string", - "enum":[ - "attaching", - "attached", - "detaching", - "detached" - ] - }, - "VolumeAttributeName":{ - "type":"string", - "enum":[ - "autoEnableIO", - "productCodes" - ] - }, - "VolumeDetail":{ - "type":"structure", - "required":["Size"], - "members":{ - "Size":{ - "shape":"Long", - "documentation":"The size of the volume, in GiB.
", - "locationName":"size" - } - }, - "documentation":"Describes an Amazon EBS volume.
" - }, - "VolumeIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VolumeId" - } - }, - "VolumeList":{ - "type":"list", - "member":{ - "shape":"Volume", - "locationName":"item" - } - }, - "VolumeState":{ - "type":"string", - "enum":[ - "creating", - "available", - "in-use", - "deleting", - "deleted", - "error" - ] - }, - "VolumeStatusAction":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The code identifying the operation, for example, enable-volume-io.
A description of the operation.
", - "locationName":"description" - }, - "EventType":{ - "shape":"String", - "documentation":"The event type associated with this operation.
", - "locationName":"eventType" - }, - "EventId":{ - "shape":"String", - "documentation":"The ID of the event associated with this operation.
", - "locationName":"eventId" - } - }, - "documentation":"Describes a volume status operation code.
" - }, - "VolumeStatusActionsList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusAction", - "locationName":"item" - } - }, - "VolumeStatusDetails":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"VolumeStatusName", - "documentation":"The name of the volume status.
", - "locationName":"name" - }, - "Status":{ - "shape":"String", - "documentation":"The intended status of the volume status.
", - "locationName":"status" - } - }, - "documentation":"Describes a volume status.
" - }, - "VolumeStatusDetailsList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusDetails", - "locationName":"item" - } - }, - "VolumeStatusEvent":{ - "type":"structure", - "members":{ - "EventType":{ - "shape":"String", - "documentation":"The type of this event.
", - "locationName":"eventType" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the event.
", - "locationName":"description" - }, - "NotBefore":{ - "shape":"DateTime", - "documentation":"The earliest start time of the event.
", - "locationName":"notBefore" - }, - "NotAfter":{ - "shape":"DateTime", - "documentation":"The latest end time of the event.
", - "locationName":"notAfter" - }, - "EventId":{ - "shape":"String", - "documentation":"The ID of this event.
", - "locationName":"eventId" - } - }, - "documentation":"Describes a volume status event.
" - }, - "VolumeStatusEventsList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusEvent", - "locationName":"item" - } - }, - "VolumeStatusInfo":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"VolumeStatusInfoStatus", - "documentation":"The status of the volume.
", - "locationName":"status" - }, - "Details":{ - "shape":"VolumeStatusDetailsList", - "documentation":"The details of the volume status.
", - "locationName":"details" - } - }, - "documentation":"Describes the status of a volume.
" - }, - "VolumeStatusInfoStatus":{ - "type":"string", - "enum":[ - "ok", - "impaired", - "insufficient-data" - ] - }, - "VolumeStatusItem":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
", - "locationName":"volumeId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the volume.
", - "locationName":"availabilityZone" - }, - "VolumeStatus":{ - "shape":"VolumeStatusInfo", - "documentation":"The volume status.
", - "locationName":"volumeStatus" - }, - "Events":{ - "shape":"VolumeStatusEventsList", - "documentation":"A list of events associated with the volume.
", - "locationName":"eventsSet" - }, - "Actions":{ - "shape":"VolumeStatusActionsList", - "documentation":"The details of the operation.
", - "locationName":"actionsSet" - } - }, - "documentation":"Describes the volume status.
" - }, - "VolumeStatusList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusItem", - "locationName":"item" - } - }, - "VolumeStatusName":{ - "type":"string", - "enum":[ - "io-enabled", - "io-performance" - ] - }, - "VolumeType":{ - "type":"string", - "enum":[ - "standard", - "io1", - "gp2" - ] - }, - "Vpc":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "State":{ - "shape":"VpcState", - "documentation":"The current state of the VPC.
", - "locationName":"state" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The CIDR block for the VPC.
", - "locationName":"cidrBlock" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).
Any tags assigned to the VPC.
", - "locationName":"tagSet" - }, - "InstanceTenancy":{ - "shape":"Tenancy", - "documentation":"The allowed tenancy of instances launched into the VPC.
", - "locationName":"instanceTenancy" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPC is the default VPC.
", - "locationName":"isDefault" - } - }, - "documentation":"Describes a VPC.
" - }, - "VpcAttachment":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "State":{ - "shape":"AttachmentStatus", - "documentation":"The current state of the attachment.
", - "locationName":"state" - } - }, - "documentation":"Describes an attachment between a virtual private gateway and a VPC.
" - }, - "VpcAttachmentList":{ - "type":"list", - "member":{ - "shape":"VpcAttachment", - "locationName":"item" - } - }, - "VpcAttributeName":{ - "type":"string", - "enum":[ - "enableDnsSupport", - "enableDnsHostnames" - ] - }, - "VpcIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpcId" - } - }, - "VpcList":{ - "type":"list", - "member":{ - "shape":"Vpc", - "locationName":"item" - } - }, - "VpcPeeringConnection":{ - "type":"structure", - "members":{ - "AccepterVpcInfo":{ - "shape":"VpcPeeringConnectionVpcInfo", - "documentation":"The information of the peer VPC.
", - "locationName":"accepterVpcInfo" - }, - "ExpirationTime":{ - "shape":"DateTime", - "documentation":"The time that an unaccepted VPC peering connection will expire.
", - "locationName":"expirationTime" - }, - "RequesterVpcInfo":{ - "shape":"VpcPeeringConnectionVpcInfo", - "documentation":"The information of the requester VPC.
", - "locationName":"requesterVpcInfo" - }, - "Status":{ - "shape":"VpcPeeringConnectionStateReason", - "documentation":"The status of the VPC peering connection.
", - "locationName":"status" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - }, - "documentation":"Describes a VPC peering connection.
" - }, - "VpcPeeringConnectionList":{ - "type":"list", - "member":{ - "shape":"VpcPeeringConnection", - "locationName":"item" - } - }, - "VpcPeeringConnectionStateReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The status of the VPC peering connection.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"A message that provides more information about the status, if applicable.
", - "locationName":"message" - } - }, - "documentation":"Describes the status of a VPC peering connection.
" - }, - "VpcPeeringConnectionVpcInfo":{ - "type":"structure", - "members":{ - "CidrBlock":{ - "shape":"String", - "documentation":"The CIDR block for the VPC.
", - "locationName":"cidrBlock" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the VPC owner.
", - "locationName":"ownerId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - }, - "documentation":"Describes a VPC in a VPC peering connection.
" - }, - "VpcState":{ - "type":"string", - "enum":[ - "pending", - "available" - ] - }, - "VpnConnection":{ - "type":"structure", - "members":{ - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
", - "locationName":"vpnConnectionId" - }, - "State":{ - "shape":"VpnState", - "documentation":"The current state of the VPN connection.
", - "locationName":"state" - }, - "CustomerGatewayConfiguration":{ - "shape":"String", - "documentation":"The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
The type of VPN connection.
", - "locationName":"type" - }, - "CustomerGatewayId":{ - "shape":"String", - "documentation":"The ID of the customer gateway at your end of the VPN connection.
", - "locationName":"customerGatewayId" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway at the AWS side of the VPN connection.
", - "locationName":"vpnGatewayId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the VPN connection.
", - "locationName":"tagSet" - }, - "VgwTelemetry":{ - "shape":"VgwTelemetryList", - "documentation":"Information about the VPN tunnel.
", - "locationName":"vgwTelemetry" - }, - "Options":{ - "shape":"VpnConnectionOptions", - "documentation":"The VPN connection options.
", - "locationName":"options" - }, - "Routes":{ - "shape":"VpnStaticRouteList", - "documentation":"The static routes associated with the VPN connection.
", - "locationName":"routes" - } - }, - "documentation":"Describes a VPN connection.
" - }, - "VpnConnectionIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpnConnectionId" - } - }, - "VpnConnectionList":{ - "type":"list", - "member":{ - "shape":"VpnConnection", - "locationName":"item" - } - }, - "VpnConnectionOptions":{ - "type":"structure", - "members":{ - "StaticRoutesOnly":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
", - "locationName":"staticRoutesOnly" - } - }, - "documentation":"Describes VPN connection options.
" - }, - "VpnConnectionOptionsSpecification":{ - "type":"structure", - "members":{ - "StaticRoutesOnly":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
", - "locationName":"staticRoutesOnly" - } - }, - "documentation":"Describes VPN connection options.
" - }, - "VpnGateway":{ - "type":"structure", - "members":{ - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
", - "locationName":"vpnGatewayId" - }, - "State":{ - "shape":"VpnState", - "documentation":"The current state of the virtual private gateway.
", - "locationName":"state" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection the virtual private gateway supports.
", - "locationName":"type" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where the virtual private gateway was created.
", - "locationName":"availabilityZone" - }, - "VpcAttachments":{ - "shape":"VpcAttachmentList", - "documentation":"Any VPCs attached to the virtual private gateway.
", - "locationName":"attachments" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the virtual private gateway.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a virtual private gateway.
" - }, - "VpnGatewayIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpnGatewayId" - } - }, - "VpnGatewayList":{ - "type":"list", - "member":{ - "shape":"VpnGateway", - "locationName":"item" - } - }, - "VpnState":{ - "type":"string", - "enum":[ - "pending", - "available", - "deleting", - "deleted" - ] - }, - "VpnStaticRoute":{ - "type":"structure", - "members":{ - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block associated with the local subnet of the customer data center.
", - "locationName":"destinationCidrBlock" - }, - "Source":{ - "shape":"VpnStaticRouteSource", - "documentation":"Indicates how the routes were provided.
", - "locationName":"source" - }, - "State":{ - "shape":"VpnState", - "documentation":"The current state of the static route.
", - "locationName":"state" - } - }, - "documentation":"Describes a static route for a VPN connection.
" - }, - "VpnStaticRouteList":{ - "type":"list", - "member":{ - "shape":"VpnStaticRoute", - "locationName":"item" - } - }, - "VpnStaticRouteSource":{ - "type":"string", - "enum":["Static"] - }, - "ZoneNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ZoneName" - } - }, - "NewDhcpConfigurationList":{ - "type":"list", - "member":{ - "shape":"NewDhcpConfiguration", - "locationName":"item" - } - }, - "NewDhcpConfiguration":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "locationName":"key" - }, - "Values":{ - "shape":"ValueStringList", - "locationName":"Value" - } - } - }, - "DhcpConfigurationValueList":{ - "type":"list", - "member":{ - "shape":"AttributeValue", - "locationName":"item" - } - }, - "Blob":{"type":"blob"}, - "BlobAttributeValue":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"Blob", - "locationName":"value" - } - } - }, - "RequestSpotLaunchSpecification":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "SecurityGroups":{ - "shape":"ValueStringList", - "locationName":"SecurityGroup" - }, - "UserData":{ - "shape":"String", - "documentation":"The Base64-encoded MIME user data to make available to the instances.
", - "locationName":"userData" - }, - "AddressingType":{ - "shape":"String", - "documentation":"Deprecated.
", - "locationName":"addressingType" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
Default: m1.small
The placement information for the instance.
", - "locationName":"placement" - }, - "KernelId":{ - "shape":"String", - "documentation":"The ID of the kernel.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The ID of the RAM disk.
", - "locationName":"ramdiskId" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"One or more block device mapping entries.
", - "locationName":"blockDeviceMapping" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which to launch the Spot Instance.
", - "locationName":"subnetId" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceSpecificationList", - "documentation":"One or more network interfaces.
", - "locationName":"NetworkInterface" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfileSpecification", - "documentation":"The IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Describes the launch specification of a Spot Instance.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.paginators.json deleted file mode 100644 index b643e696c1..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.paginators.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "pagination": { - "DescribeInstanceStatus": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "InstanceStatuses" - }, - "DescribeInstances": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Reservations" - }, - "DescribeReservedInstancesModifications": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "ReservedInstancesModifications" - }, - "DescribeReservedInstancesOfferings": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ReservedInstancesOfferings" - }, - "DescribeSpotPriceHistory": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "SpotPriceHistory" - }, - "DescribeTags": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Tags" - }, - "DescribeVolumeStatus": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "VolumeStatuses" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.waiters.json deleted file mode 100644 index fb8c16bdf2..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-09-01.waiters.json +++ /dev/null @@ -1,341 +0,0 @@ -{ - "version": 2, - "waiters": { - "BundleTaskComplete": { - "delay": 15, - "operation": "DescribeBundleTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "complete", - "matcher": "pathAll", - "state": "success", - "argument": "BundleTasks[].State" - }, - { - "expected": "failed", - "matcher": "pathAny", - "state": "failure", - "argument": "BundleTasks[].State" - } - ] - }, - "ConversionTaskCancelled": { - "delay": 15, - "operation": "DescribeConversionTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "cancelled", - "matcher": "pathAll", - "state": "success", - "argument": "ConversionTasks[].State" - } - ] - }, - "ConversionTaskCompleted": { - "delay": 15, - "operation": "DescribeConversionTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "completed", - "matcher": "pathAll", - "state": "success", - "argument": "ConversionTasks[].State" - }, - { - "expected": "cancelled", - "matcher": "pathAny", - "state": "failure", - "argument": "ConversionTasks[].State" - }, - { - "expected": "cancelling", - "matcher": "pathAny", - "state": "failure", - "argument": "ConversionTasks[].State" - } - ] - }, - "ConversionTaskDeleted": { - "delay": 15, - "operation": "DescribeConversionTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "ConversionTasks[].State" - } - ] - }, - "CustomerGatewayAvailable": { - "delay": 15, - "operation": "DescribeCustomerGateways", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "CustomerGateways[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "CustomerGateways[].State" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "CustomerGateways[].State" - } - ] - }, - "ExportTaskCancelled": { - "delay": 15, - "operation": "DescribeExportTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "cancelled", - "matcher": "pathAll", - "state": "success", - "argument": "ExportTasks[].State" - } - ] - }, - "ExportTaskCompleted": { - "delay": 15, - "operation": "DescribeExportTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "completed", - "matcher": "pathAll", - "state": "success", - "argument": "ExportTasks[].State" - } - ] - }, - "InstanceRunning": { - "delay": 15, - "operation": "DescribeInstances", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "running", - "matcher": "pathAll", - "state": "success", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "shutting-down", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "terminated", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "stopping", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - } - ] - }, - "InstanceStopped": { - "delay": 15, - "operation": "DescribeInstances", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "stopped", - "matcher": "pathAll", - "state": "success", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "pending", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "terminated", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - } - ] - }, - "InstanceTerminated": { - "delay": 15, - "operation": "DescribeInstances", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "terminated", - "matcher": "pathAll", - "state": "success", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "pending", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "stopping", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - } - ] - }, - "SnapshotCompleted": { - "delay": 15, - "operation": "DescribeSnapshots", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "completed", - "matcher": "pathAll", - "state": "success", - "argument": "Snapshots[].State" - } - ] - }, - "SubnetAvailable": { - "delay": 15, - "operation": "DescribeSubnets", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Subnets[].State" - } - ] - }, - "VolumeAvailable": { - "delay": 15, - "operation": "DescribeVolumes", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Volumes[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "Volumes[].State" - } - ] - }, - "VolumeDeleted": { - "delay": 15, - "operation": "DescribeVolumes", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "Volumes[].State" - } - ] - }, - "VolumeInUse": { - "delay": 15, - "operation": "DescribeVolumes", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "in-use", - "matcher": "pathAll", - "state": "success", - "argument": "Volumes[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "Volumes[].State" - } - ] - }, - "VpcAvailable": { - "delay": 15, - "operation": "DescribeVpcs", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Vpcs[].State" - } - ] - }, - "VpnConnectionAvailable": { - "delay": 15, - "operation": "DescribeVpnConnections", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "VpnConnections[].State" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "VpnConnections[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "VpnConnections[].State" - } - ] - }, - "VpnConnectionDeleted": { - "delay": 15, - "operation": "DescribeVpnConnections", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "VpnConnections[].State" - }, - { - "expected": "pending", - "matcher": "pathAny", - "state": "failure", - "argument": "VpnConnections[].State" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.normal.json deleted file mode 100644 index d86342b083..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.normal.json +++ /dev/null @@ -1,12061 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-10-01", - "endpointPrefix":"ec2", - "serviceAbbreviation":"Amazon EC2", - "serviceFullName":"Amazon Elastic Compute Cloud", - "signatureVersion":"v4", - "xmlNamespace":"http://ec2.amazonaws.com/doc/2014-10-01", - "protocol":"ec2" - }, - "documentation":"Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.
", - "operations":{ - "AcceptVpcPeeringConnection":{ - "name":"AcceptVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, - "output":{"shape":"AcceptVpcPeeringConnectionResult"}, - "documentation":"Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.
Acquires an Elastic IP address.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "AssignPrivateIpAddresses":{ - "name":"AssignPrivateIpAddresses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssignPrivateIpAddressesRequest"}, - "documentation":"Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.
AssignPrivateIpAddresses is available only in EC2-VPC.
" - }, - "AssociateAddress":{ - "name":"AssociateAddress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateAddressRequest"}, - "output":{"shape":"AssociateAddressResult"}, - "documentation":"Associates an Elastic IP address with an instance or a network interface.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" - }, - "AssociateDhcpOptions":{ - "name":"AssociateDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateDhcpOptionsRequest"}, - "documentation":"Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
" - }, - "AssociateRouteTable":{ - "name":"AssociateRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateRouteTableRequest"}, - "output":{"shape":"AssociateRouteTableResult"}, - "documentation":"Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "AttachClassicLinkVpc":{ - "name":"AttachClassicLinkVpc", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachClassicLinkVpcRequest"}, - "output":{"shape":"AttachClassicLinkVpcResult"}, - "documentation":"Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
" - }, - "AttachInternetGateway":{ - "name":"AttachInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachInternetGatewayRequest"}, - "documentation":"Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.
" - }, - "AttachNetworkInterface":{ - "name":"AttachNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachNetworkInterfaceRequest"}, - "output":{"shape":"AttachNetworkInterfaceResult"}, - "documentation":"Attaches a network interface to an instance.
" - }, - "AttachVolume":{ - "name":"AttachVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachVolumeRequest"}, - "output":{ - "shape":"VolumeAttachment", - "locationName":"attachment" - }, - "documentation":"Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.
For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide for Linux.
If a volume has an AWS Marketplace product code:
For an overview of the AWS Marketplace, see Introducing AWS Marketplace.
For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "AttachVpnGateway":{ - "name":"AttachVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachVpnGatewayRequest"}, - "output":{"shape":"AttachVpnGatewayResult"}, - "documentation":"Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "AuthorizeSecurityGroupEgress":{ - "name":"AuthorizeSecurityGroupEgress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, - "documentation":"Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.
You can have up to 50 rules per security group (covering both ingress and egress rules).
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
" - }, - "AuthorizeSecurityGroupIngress":{ - "name":"AuthorizeSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, - "documentation":"Adds one or more ingress rules to a security group.
EC2-Classic: You can have up to 100 rules per group.
EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.
[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.
" - }, - "BundleInstance":{ - "name":"BundleInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BundleInstanceRequest"}, - "output":{"shape":"BundleInstanceResult"}, - "documentation":"Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
For more information, see Creating an Instance Store-Backed Windows AMI.
" - }, - "CancelBundleTask":{ - "name":"CancelBundleTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelBundleTaskRequest"}, - "output":{"shape":"CancelBundleTaskResult"}, - "documentation":"Cancels a bundling operation for an instance store-backed Windows instance.
" - }, - "CancelConversionTask":{ - "name":"CancelConversionTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelConversionRequest"}, - "documentation":"Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CancelExportTask":{ - "name":"CancelExportTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelExportTaskRequest"}, - "documentation":"Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
" - }, - "CancelReservedInstancesListing":{ - "name":"CancelReservedInstancesListing", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelReservedInstancesListingRequest"}, - "output":{"shape":"CancelReservedInstancesListingResult"}, - "documentation":"Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CancelSpotInstanceRequests":{ - "name":"CancelSpotInstanceRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CancelSpotInstanceRequestsRequest"}, - "output":{"shape":"CancelSpotInstanceRequestsResult"}, - "documentation":"Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.
" - }, - "CopyImage":{ - "name":"CopyImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CopyImageRequest"}, - "output":{"shape":"CopyImageResult"}, - "documentation":"Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.
For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CopySnapshot":{ - "name":"CopySnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CopySnapshotRequest"}, - "output":{"shape":"CopySnapshotResult"}, - "documentation":"Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.
Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.
Copying snapshots that were encrypted with non-default AWS Key Management Service (KMS) master keys is not supported at this time.
For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateCustomerGateway":{ - "name":"CreateCustomerGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCustomerGatewayRequest"}, - "output":{"shape":"CreateCustomerGatewayResult"}, - "documentation":"Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.
For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateDhcpOptions":{ - "name":"CreateDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDhcpOptionsRequest"}, - "output":{"shape":"CreateDhcpOptionsResult"}, - "documentation":"Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.netbios-name-servers - The IP addresses of up to four NetBIOS name servers.netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132. Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateInstanceExportTask":{ - "name":"CreateInstanceExportTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInstanceExportTaskRequest"}, - "output":{"shape":"CreateInstanceExportTaskResult"}, - "documentation":"Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateInternetGateway":{ - "name":"CreateInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInternetGatewayRequest"}, - "output":{"shape":"CreateInternetGatewayResult"}, - "documentation":"Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateKeyPair":{ - "name":"CreateKeyPair", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateKeyPairRequest"}, - "output":{ - "shape":"KeyPair", - "documentation":"Information about the key pair.
", - "locationName":"keyPair" - }, - "documentation":"Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per region.
The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateNetworkAcl":{ - "name":"CreateNetworkAcl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkAclRequest"}, - "output":{"shape":"CreateNetworkAclResult"}, - "documentation":"Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateNetworkAclEntry":{ - "name":"CreateNetworkAclEntry", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkAclEntryRequest"}, - "documentation":"Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateNetworkInterface":{ - "name":"CreateNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateNetworkInterfaceRequest"}, - "output":{"shape":"CreateNetworkInterfaceResult"}, - "documentation":"Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreatePlacementGroup":{ - "name":"CreatePlacementGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreatePlacementGroupRequest"}, - "documentation":"Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.
For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateReservedInstancesListing":{ - "name":"CreateReservedInstancesListing", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateReservedInstancesListingRequest"}, - "output":{"shape":"CreateReservedInstancesListingResult"}, - "documentation":"Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateRoute":{ - "name":"CreateRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRouteRequest"}, - "documentation":"Creates a route in a route table within a VPC.
You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.
When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateRouteTable":{ - "name":"CreateRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRouteTableRequest"}, - "output":{"shape":"CreateRouteTableResult"}, - "documentation":"Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateSecurityGroup":{ - "name":"CreateSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSecurityGroupRequest"}, - "output":{"shape":"CreateSecurityGroupResult"}, - "documentation":"Creates a security group.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
EC2-Classic: You can have up to 500 security groups.
EC2-VPC: You can create up to 100 security groups per VPC.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
" - }, - "CreateSnapshot":{ - "name":"CreateSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSnapshotRequest"}, - "output":{ - "shape":"Snapshot", - "locationName":"snapshot" - }, - "documentation":"Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateSpotDatafeedSubscription":{ - "name":"CreateSpotDatafeedSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, - "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, - "documentation":"Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateSubnet":{ - "name":"CreateSubnet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSubnetRequest"}, - "output":{"shape":"CreateSubnetResult"}, - "documentation":"Creates a subnet in an existing VPC.
When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).
AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateTags":{ - "name":"CreateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateTagsRequest"}, - "documentation":"Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateVolume":{ - "name":"CreateVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVolumeRequest"}, - "output":{ - "shape":"Volume", - "locationName":"volume" - }, - "documentation":"Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.
You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.
For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "CreateVpc":{ - "name":"CreateVpc", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpcRequest"}, - "output":{"shape":"CreateVpcResult"}, - "documentation":"Creates a VPC with the specified CIDR block.
The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateVpcPeeringConnection":{ - "name":"CreateVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpcPeeringConnectionRequest"}, - "output":{"shape":"CreateVpcPeeringConnectionResult"}, - "documentation":"Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.
The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateVpnConnectionRoute":{ - "name":"CreateVpnConnectionRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpnConnectionRouteRequest"}, - "documentation":"Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "CreateVpnGateway":{ - "name":"CreateVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVpnGatewayRequest"}, - "output":{"shape":"CreateVpnGatewayResult"}, - "documentation":"Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DeleteCustomerGateway":{ - "name":"DeleteCustomerGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteCustomerGatewayRequest"}, - "documentation":"Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
" - }, - "DeleteDhcpOptions":{ - "name":"DeleteDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteDhcpOptionsRequest"}, - "documentation":"Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
" - }, - "DeleteInternetGateway":{ - "name":"DeleteInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInternetGatewayRequest"}, - "documentation":"Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.
" - }, - "DeleteKeyPair":{ - "name":"DeleteKeyPair", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteKeyPairRequest"}, - "documentation":"Deletes the specified key pair, by removing the public key from Amazon EC2.
" - }, - "DeleteNetworkAcl":{ - "name":"DeleteNetworkAcl", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkAclRequest"}, - "documentation":"Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
" - }, - "DeleteNetworkAclEntry":{ - "name":"DeleteNetworkAclEntry", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkAclEntryRequest"}, - "documentation":"Deletes the specified ingress or egress entry (rule) from the specified network ACL.
" - }, - "DeleteNetworkInterface":{ - "name":"DeleteNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteNetworkInterfaceRequest"}, - "documentation":"Deletes the specified network interface. You must detach the network interface before you can delete it.
" - }, - "DeletePlacementGroup":{ - "name":"DeletePlacementGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePlacementGroupRequest"}, - "documentation":"Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DeleteRoute":{ - "name":"DeleteRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRouteRequest"}, - "documentation":"Deletes the specified route from the specified route table.
" - }, - "DeleteRouteTable":{ - "name":"DeleteRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRouteTableRequest"}, - "documentation":"Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
" - }, - "DeleteSecurityGroup":{ - "name":"DeleteSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSecurityGroupRequest"}, - "documentation":"Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DeleteSpotDatafeedSubscription":{ - "name":"DeleteSpotDatafeedSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, - "documentation":"Deletes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DeleteSubnet":{ - "name":"DeleteSubnet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSubnetRequest"}, - "documentation":"Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
" - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTagsRequest"}, - "documentation":"Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DeleteVolume":{ - "name":"DeleteVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVolumeRequest"}, - "documentation":"Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).
The volume may remain in the deleting state for several minutes.
For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DeleteVpc":{ - "name":"DeleteVpc", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpcRequest"}, - "documentation":"Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
" - }, - "DeleteVpcPeeringConnection":{ - "name":"DeleteVpcPeeringConnection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, - "output":{"shape":"DeleteVpcPeeringConnectionResult"}, - "documentation":"Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.
" - }, - "DeleteVpnConnectionRoute":{ - "name":"DeleteVpnConnectionRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpnConnectionRouteRequest"}, - "documentation":"Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
" - }, - "DeleteVpnGateway":{ - "name":"DeleteVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVpnGatewayRequest"}, - "documentation":"Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
" - }, - "DeregisterImage":{ - "name":"DeregisterImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterImageRequest"}, - "documentation":"Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
This command does not delete the AMI.
" - }, - "DescribeAccountAttributes":{ - "name":"DescribeAccountAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAccountAttributesRequest"}, - "output":{"shape":"DescribeAccountAttributesResult"}, - "documentation":"Describes attributes of your AWS account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: The maximum number of On-Demand instances that you can run.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
Describes one or more of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeAvailabilityZones":{ - "name":"DescribeAvailabilityZones", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAvailabilityZonesRequest"}, - "output":{"shape":"DescribeAvailabilityZonesResult"}, - "documentation":"Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeBundleTasks":{ - "name":"DescribeBundleTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeBundleTasksRequest"}, - "output":{"shape":"DescribeBundleTasksResult"}, - "documentation":"Describes one or more of your bundling tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.
" - }, - "DescribeConversionTasks":{ - "name":"DescribeConversionTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeConversionTasksRequest"}, - "output":{"shape":"DescribeConversionTasksResult"}, - "documentation":"Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeCustomerGateways":{ - "name":"DescribeCustomerGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCustomerGatewaysRequest"}, - "output":{"shape":"DescribeCustomerGatewaysResult"}, - "documentation":"Describes one or more of your VPN customer gateways.
For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeDhcpOptions":{ - "name":"DescribeDhcpOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDhcpOptionsRequest"}, - "output":{"shape":"DescribeDhcpOptionsResult"}, - "documentation":"Describes one or more of your DHCP options sets.
For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeExportTasks":{ - "name":"DescribeExportTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeExportTasksRequest"}, - "output":{"shape":"DescribeExportTasksResult"}, - "documentation":"Describes one or more of your export tasks.
" - }, - "DescribeImageAttribute":{ - "name":"DescribeImageAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImageAttributeRequest"}, - "output":{ - "shape":"ImageAttribute", - "documentation":"Information about the image attribute.
", - "locationName":"imageAttribute" - }, - "documentation":"Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
" - }, - "DescribeImages":{ - "name":"DescribeImages", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeImagesRequest"}, - "output":{"shape":"DescribeImagesResult"}, - "documentation":"Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
Deregistered images are included in the returned results for an unspecified interval after deregistration.
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
Describes the status of one or more instances, including any scheduled events.
Instance status has two main components:
System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.
Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.
Instance status provides information about four types of scheduled events for an instance that may require your attention:
Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.
System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.
Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.
Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.
When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.
For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeInstances":{ - "name":"DescribeInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInstancesRequest"}, - "output":{"shape":"DescribeInstancesResult"}, - "documentation":"Describes one or more of your instances.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
" - }, - "DescribeInternetGateways":{ - "name":"DescribeInternetGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInternetGatewaysRequest"}, - "output":{"shape":"DescribeInternetGatewaysResult"}, - "documentation":"Describes one or more of your Internet gateways.
" - }, - "DescribeKeyPairs":{ - "name":"DescribeKeyPairs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeKeyPairsRequest"}, - "output":{"shape":"DescribeKeyPairsResult"}, - "documentation":"Describes one or more of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeNetworkAcls":{ - "name":"DescribeNetworkAcls", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNetworkAclsRequest"}, - "output":{"shape":"DescribeNetworkAclsResult"}, - "documentation":"Describes one or more of your network ACLs.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeNetworkInterfaceAttribute":{ - "name":"DescribeNetworkInterfaceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, - "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, - "documentation":"Describes a network interface attribute. You can specify only one attribute at a time.
" - }, - "DescribeNetworkInterfaces":{ - "name":"DescribeNetworkInterfaces", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeNetworkInterfacesRequest"}, - "output":{"shape":"DescribeNetworkInterfacesResult"}, - "documentation":"Describes one or more of your network interfaces.
" - }, - "DescribePlacementGroups":{ - "name":"DescribePlacementGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePlacementGroupsRequest"}, - "output":{"shape":"DescribePlacementGroupsResult"}, - "documentation":"Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeRegions":{ - "name":"DescribeRegions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRegionsRequest"}, - "output":{"shape":"DescribeRegionsResult"}, - "documentation":"Describes one or more regions that are currently available to you.
For a list of the regions supported by Amazon EC2, see Regions and Endpoints.
" - }, - "DescribeReservedInstances":{ - "name":"DescribeReservedInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesRequest"}, - "output":{"shape":"DescribeReservedInstancesResult"}, - "documentation":"Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeReservedInstancesListings":{ - "name":"DescribeReservedInstancesListings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesListingsRequest"}, - "output":{"shape":"DescribeReservedInstancesListingsResult"}, - "documentation":"Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeReservedInstancesModifications":{ - "name":"DescribeReservedInstancesModifications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, - "output":{"shape":"DescribeReservedInstancesModificationsResult"}, - "documentation":"Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeReservedInstancesOfferings":{ - "name":"DescribeReservedInstancesOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, - "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, - "documentation":"Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeRouteTables":{ - "name":"DescribeRouteTables", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRouteTablesRequest"}, - "output":{"shape":"DescribeRouteTablesResult"}, - "documentation":"Describes one or more of your route tables.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeSecurityGroups":{ - "name":"DescribeSecurityGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSecurityGroupsRequest"}, - "output":{"shape":"DescribeSecurityGroupsResult"}, - "documentation":"Describes one or more of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeSnapshotAttribute":{ - "name":"DescribeSnapshotAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSnapshotAttributeRequest"}, - "output":{"shape":"DescribeSnapshotAttributeResult"}, - "documentation":"Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeSnapshots":{ - "name":"DescribeSnapshots", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSnapshotsRequest"}, - "output":{"shape":"DescribeSnapshotsResult"}, - "documentation":"Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
The create volume permissions fall into the following categories:
all group. All AWS accounts have create volume permissions for these snapshots.The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeSpotDatafeedSubscription":{ - "name":"DescribeSpotDatafeedSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, - "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, - "documentation":"Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeSpotInstanceRequests":{ - "name":"DescribeSpotInstanceRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, - "output":{"shape":"DescribeSpotInstanceRequestsResult"}, - "documentation":"Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
Describes the Spot Price history. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide for Linux.
When you specify an Availability Zone, this operation describes the price history for the specified Availability Zone with the most recent set of prices listed first. If you don't specify an Availability Zone, you get the prices across all Availability Zones, starting with the most recent set. However, if you're using an API version earlier than 2011-05-15, you get the lowest price across the region for the specified time period. The prices returned are listed in chronological order, from the oldest to the most recent.
When you specify the start and end time options, this operation returns two pieces of data: the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
" - }, - "DescribeSubnets":{ - "name":"DescribeSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeSubnetsRequest"}, - "output":{"shape":"DescribeSubnetsResult"}, - "documentation":"Describes one or more of your subnets.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeTags":{ - "name":"DescribeTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTagsRequest"}, - "output":{"shape":"DescribeTagsResult"}, - "documentation":"Describes one or more of the tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeVolumeAttribute":{ - "name":"DescribeVolumeAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVolumeAttributeRequest"}, - "output":{"shape":"DescribeVolumeAttributeResult"}, - "documentation":"Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeVolumeStatus":{ - "name":"DescribeVolumeStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVolumeStatusRequest"}, - "output":{"shape":"DescribeVolumeStatusResult"}, - "documentation":"Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.
Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.
Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
Describes the specified Amazon EBS volumes.
If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DescribeVpcAttribute":{ - "name":"DescribeVpcAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcAttributeRequest"}, - "output":{"shape":"DescribeVpcAttributeResult"}, - "documentation":"Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
" - }, - "DescribeVpcClassicLink":{ - "name":"DescribeVpcClassicLink", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcClassicLinkRequest"}, - "output":{"shape":"DescribeVpcClassicLinkResult"}, - "documentation":"Describes the ClassicLink status of one or more VPCs.
" - }, - "DescribeVpcPeeringConnections":{ - "name":"DescribeVpcPeeringConnections", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, - "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, - "documentation":"Describes one or more of your VPC peering connections.
" - }, - "DescribeVpcs":{ - "name":"DescribeVpcs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpcsRequest"}, - "output":{"shape":"DescribeVpcsResult"}, - "documentation":"Describes one or more of your VPCs.
" - }, - "DescribeVpnConnections":{ - "name":"DescribeVpnConnections", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpnConnectionsRequest"}, - "output":{"shape":"DescribeVpnConnectionsResult"}, - "documentation":"Describes one or more of your VPN connections.
For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DescribeVpnGateways":{ - "name":"DescribeVpnGateways", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVpnGatewaysRequest"}, - "output":{"shape":"DescribeVpnGatewaysResult"}, - "documentation":"Describes one or more of your virtual private gateways.
For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.
" - }, - "DetachClassicLinkVpc":{ - "name":"DetachClassicLinkVpc", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachClassicLinkVpcRequest"}, - "output":{"shape":"DetachClassicLinkVpcResult"}, - "documentation":"Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
" - }, - "DetachInternetGateway":{ - "name":"DetachInternetGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachInternetGatewayRequest"}, - "documentation":"Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.
" - }, - "DetachNetworkInterface":{ - "name":"DetachNetworkInterface", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachNetworkInterfaceRequest"}, - "documentation":"Detaches a network interface from an instance.
" - }, - "DetachVolume":{ - "name":"DetachVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachVolumeRequest"}, - "output":{ - "shape":"VolumeAttachment", - "locationName":"attachment" - }, - "documentation":"Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.
If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "DetachVpnGateway":{ - "name":"DetachVpnGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachVpnGatewayRequest"}, - "documentation":"Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
" - }, - "DisableVpcClassicLink":{ - "name":"DisableVpcClassicLink", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableVpcClassicLinkRequest"}, - "output":{"shape":"DisableVpcClassicLinkResult"}, - "documentation":"Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
" - }, - "DisassociateAddress":{ - "name":"DisassociateAddress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateAddressRequest"}, - "documentation":"Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" - }, - "DisassociateRouteTable":{ - "name":"DisassociateRouteTable", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateRouteTableRequest"}, - "documentation":"Disassociates a subnet from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "EnableVgwRoutePropagation":{ - "name":"EnableVgwRoutePropagation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableVgwRoutePropagationRequest"}, - "documentation":"Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
" - }, - "EnableVolumeIO":{ - "name":"EnableVolumeIO", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableVolumeIORequest"}, - "documentation":"Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
" - }, - "EnableVpcClassicLink":{ - "name":"EnableVpcClassicLink", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableVpcClassicLinkRequest"}, - "output":{"shape":"EnableVpcClassicLinkResult"}, - "documentation":"Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide for Linux.
Gets the console output for the specified instance.
Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.
Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.
For Linux/Unix instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a machine. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.
For Windows instances, the instance console output displays the last three system event log errors.
" - }, - "GetPasswordData":{ - "name":"GetPasswordData", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPasswordDataRequest"}, - "output":{"shape":"GetPasswordDataResult"}, - "documentation":"Retrieves the encrypted administrator password for an instance running Windows.
The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
" - }, - "ImportInstance":{ - "name":"ImportInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportInstanceRequest"}, - "output":{"shape":"ImportInstanceResult"}, - "documentation":"Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "ImportVolume":{ - "name":"ImportVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ImportVolumeRequest"}, - "output":{"shape":"ImportVolumeResult"}, - "documentation":"Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "ModifyNetworkInterfaceAttribute":{ - "name":"ModifyNetworkInterfaceAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, - "documentation":"Modifies the specified network interface attribute. You can specify only one attribute at a time.
" - }, - "ModifyReservedInstances":{ - "name":"ModifyReservedInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyReservedInstancesRequest"}, - "output":{"shape":"ModifyReservedInstancesResult"}, - "documentation":"Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "ModifySnapshotAttribute":{ - "name":"ModifySnapshotAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifySnapshotAttributeRequest"}, - "documentation":"Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.
Snapshots with AWS Marketplace product codes cannot be made public.
Modifies a subnet attribute.
" - }, - "ModifyVolumeAttribute":{ - "name":"ModifyVolumeAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyVolumeAttributeRequest"}, - "documentation":"Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
" - }, - "ModifyVpcAttribute":{ - "name":"ModifyVpcAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ModifyVpcAttributeRequest"}, - "documentation":"Modifies the specified attribute of the specified VPC.
" - }, - "MonitorInstances":{ - "name":"MonitorInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"MonitorInstancesRequest"}, - "output":{"shape":"MonitorInstancesResult"}, - "documentation":"Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "PurchaseReservedInstancesOffering":{ - "name":"PurchaseReservedInstancesOffering", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, - "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, - "documentation":"Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "RebootInstances":{ - "name":"RebootInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RebootInstancesRequest"}, - "documentation":"Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "RegisterImage":{ - "name":"RegisterImage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterImageRequest"}, - "output":{"shape":"RegisterImageResult"}, - "documentation":"Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.
Releases the specified Elastic IP address.
After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "ReplaceNetworkAclEntry":{ - "name":"ReplaceNetworkAclEntry", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReplaceNetworkAclEntryRequest"}, - "documentation":"Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
" - }, - "ReplaceRoute":{ - "name":"ReplaceRoute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReplaceRouteRequest"}, - "documentation":"Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" - }, - "ReplaceRouteTableAssociation":{ - "name":"ReplaceRouteTableAssociation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReplaceRouteTableAssociationRequest"}, - "output":{"shape":"ReplaceRouteTableAssociationResult"}, - "documentation":"Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.
" - }, - "ReportInstanceStatus":{ - "name":"ReportInstanceStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReportInstanceStatusRequest"}, - "documentation":"Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
" - }, - "RequestSpotInstances":{ - "name":"RequestSpotInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RequestSpotInstancesRequest"}, - "output":{"shape":"RequestSpotInstancesResult"}, - "documentation":"Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.
Users must be subscribed to the required product to run an instance with AWS Marketplace product codes.
" - }, - "ResetImageAttribute":{ - "name":"ResetImageAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetImageAttributeRequest"}, - "documentation":"Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.
The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
Resets a network interface attribute. You can specify only one attribute at a time.
" - }, - "ResetSnapshotAttribute":{ - "name":"ResetSnapshotAttribute", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResetSnapshotAttributeRequest"}, - "documentation":"Resets permission settings for the specified snapshot.
For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "RevokeSecurityGroupEgress":{ - "name":"RevokeSecurityGroupEgress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RevokeSecurityGroupEgressRequest"}, - "documentation":"Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.
Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
" - }, - "RevokeSecurityGroupIngress":{ - "name":"RevokeSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RevokeSecurityGroupIngressRequest"}, - "documentation":"Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.
Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
" - }, - "RunInstances":{ - "name":"RunInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RunInstancesRequest"}, - "output":{ - "shape":"Reservation", - "documentation":"One or more reservations.
", - "locationName":"reservation" - }, - "documentation":"Launches the specified number of instances using an AMI for which you have permissions.
When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.
If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.
You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide for Linux.
If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.
T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.
For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "StartInstances":{ - "name":"StartInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartInstancesRequest"}, - "output":{"shape":"StartInstancesResult"}, - "documentation":"Starts an Amazon EBS-backed AMI that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "StopInstances":{ - "name":"StopInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInstancesRequest"}, - "output":{"shape":"StopInstancesResult"}, - "documentation":"Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.
You can't start or stop Spot Instances.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.
For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "TerminateInstances":{ - "name":"TerminateInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TerminateInstancesRequest"}, - "output":{"shape":"TerminateInstancesResult"}, - "documentation":"Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.
For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "UnassignPrivateIpAddresses":{ - "name":"UnassignPrivateIpAddresses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UnassignPrivateIpAddressesRequest"}, - "documentation":"Unassigns one or more secondary private IP addresses from a network interface.
" - }, - "UnmonitorInstances":{ - "name":"UnmonitorInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UnmonitorInstancesRequest"}, - "output":{"shape":"UnmonitorInstancesResult"}, - "documentation":"Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.
" - } - }, - "shapes":{ - "AcceptVpcPeeringConnectionRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "AcceptVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "VpcPeeringConnection":{ - "shape":"VpcPeeringConnection", - "documentation":"Information about the VPC peering connection.
", - "locationName":"vpcPeeringConnection" - } - } - }, - "AccountAttribute":{ - "type":"structure", - "members":{ - "AttributeName":{ - "shape":"String", - "documentation":"The name of the account attribute.
", - "locationName":"attributeName" - }, - "AttributeValues":{ - "shape":"AccountAttributeValueList", - "documentation":"One or more values for the account attribute.
", - "locationName":"attributeValueSet" - } - }, - "documentation":"Describes an account attribute.
" - }, - "AccountAttributeList":{ - "type":"list", - "member":{ - "shape":"AccountAttribute", - "locationName":"item" - } - }, - "AccountAttributeName":{ - "type":"string", - "enum":[ - "supported-platforms", - "default-vpc" - ] - }, - "AccountAttributeNameStringList":{ - "type":"list", - "member":{ - "shape":"AccountAttributeName", - "locationName":"attributeName" - } - }, - "AccountAttributeValue":{ - "type":"structure", - "members":{ - "AttributeValue":{ - "shape":"String", - "documentation":"The value of the attribute.
", - "locationName":"attributeValue" - } - }, - "documentation":"Describes a value of an account attribute.
" - }, - "AccountAttributeValueList":{ - "type":"list", - "member":{ - "shape":"AccountAttributeValue", - "locationName":"item" - } - }, - "Address":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance the address is associated with (if any).
", - "locationName":"instanceId" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
", - "locationName":"publicIp" - }, - "AllocationId":{ - "shape":"String", - "documentation":"The ID representing the allocation of the address for use with EC2-VPC.
", - "locationName":"allocationId" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The ID representing the association of the address with an instance in a VPC.
", - "locationName":"associationId" - }, - "Domain":{ - "shape":"DomainType", - "documentation":"Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "NetworkInterfaceOwnerId":{ - "shape":"String", - "documentation":"The ID of the AWS account that owns the network interface.
", - "locationName":"networkInterfaceOwnerId" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address associated with the Elastic IP address.
", - "locationName":"privateIpAddress" - } - }, - "documentation":"Describes an Elastic IP address.
" - }, - "AddressList":{ - "type":"list", - "member":{ - "shape":"Address", - "locationName":"item" - } - }, - "AllocateAddressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Domain":{ - "shape":"DomainType", - "documentation":"Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
" - } - } - }, - "AllocateAddressResult":{ - "type":"structure", - "members":{ - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
", - "locationName":"publicIp" - }, - "Domain":{ - "shape":"DomainType", - "documentation":"Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
", - "locationName":"allocationId" - } - } - }, - "AllocationIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"AllocationId" - } - }, - "ArchitectureValues":{ - "type":"string", - "enum":[ - "i386", - "x86_64" - ] - }, - "AssignPrivateIpAddressesRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "PrivateIpAddresses":{ - "shape":"PrivateIpAddressStringList", - "documentation":"One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
", - "locationName":"privateIpAddress" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
", - "locationName":"secondaryPrivateIpAddressCount" - }, - "AllowReassignment":{ - "shape":"Boolean", - "documentation":"Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
", - "locationName":"allowReassignment" - } - } - }, - "AssociateAddressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address. This is required for EC2-Classic.
" - }, - "AllocationId":{ - "shape":"String", - "documentation":"[EC2-VPC] The allocation ID. This is required for EC2-VPC.
" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
", - "locationName":"networkInterfaceId" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", - "locationName":"privateIpAddress" - }, - "AllowReassociation":{ - "shape":"Boolean", - "documentation":"[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.
Default: false
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
", - "locationName":"associationId" - } - } - }, - "AssociateDhcpOptionsRequest":{ - "type":"structure", - "required":[ - "DhcpOptionsId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
The ID of the VPC.
" - } - } - }, - "AssociateRouteTableRequest":{ - "type":"structure", - "required":[ - "SubnetId", - "RouteTableId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - } - } - }, - "AssociateRouteTableResult":{ - "type":"structure", - "members":{ - "AssociationId":{ - "shape":"String", - "documentation":"The route table association ID (needed to disassociate the route table).
", - "locationName":"associationId" - } - } - }, - "AttachClassicLinkVpcRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "VpcId", - "Groups" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
", - "locationName":"instanceId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of a ClassicLink-enabled VPC.
", - "locationName":"vpcId" - }, - "Groups":{ - "shape":"GroupIdStringList", - "documentation":"The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
", - "locationName":"SecurityGroupId" - } - } - }, - "AttachClassicLinkVpcResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "AttachNetworkInterfaceRequest":{ - "type":"structure", - "required":[ - "NetworkInterfaceId", - "InstanceId", - "DeviceIndex" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The index of the device for the network interface attachment.
", - "locationName":"deviceIndex" - } - } - }, - "AttachNetworkInterfaceResult":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - } - } - }, - "AttachVolumeRequest":{ - "type":"structure", - "required":[ - "VolumeId", - "InstanceId", - "Device" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - }, - "Device":{ - "shape":"String", - "documentation":"The device name to expose to the instance (for example, /dev/sdh or xvdh).
The ID of the virtual private gateway.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
" - } - } - }, - "AttachVpnGatewayResult":{ - "type":"structure", - "members":{ - "VpcAttachment":{ - "shape":"VpcAttachment", - "documentation":"Information about the attachment.
", - "locationName":"attachment" - } - } - }, - "AttachmentStatus":{ - "type":"string", - "enum":[ - "attaching", - "attached", - "detaching", - "detached" - ] - }, - "AttributeBooleanValue":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"Boolean", - "documentation":"Valid values are true or false.
The value to use when a resource attribute accepts a Boolean value.
" - }, - "AttributeValue":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"String", - "documentation":"Valid values are case-sensitive and vary by action.
", - "locationName":"value" - } - }, - "documentation":"The value to use for a resource attribute.
" - }, - "AuthorizeSecurityGroupEgressRequest":{ - "type":"structure", - "required":["GroupId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupName" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupOwnerId" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
", - "locationName":"cidrIp" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"ipPermissions" - } - } - }, - "AuthorizeSecurityGroupIngressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the security group.
" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
" - } - } - }, - "AvailabilityZone":{ - "type":"structure", - "members":{ - "ZoneName":{ - "shape":"String", - "documentation":"The name of the Availability Zone.
", - "locationName":"zoneName" - }, - "State":{ - "shape":"AvailabilityZoneState", - "documentation":"The state of the Availability Zone (available | impaired | unavailable).
The name of the region.
", - "locationName":"regionName" - }, - "Messages":{ - "shape":"AvailabilityZoneMessageList", - "documentation":"Any messages about the Availability Zone.
", - "locationName":"messageSet" - } - }, - "documentation":"Describes an Availability Zone.
" - }, - "AvailabilityZoneList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZone", - "locationName":"item" - } - }, - "AvailabilityZoneMessage":{ - "type":"structure", - "members":{ - "Message":{ - "shape":"String", - "documentation":"The message about the Availability Zone.
", - "locationName":"message" - } - }, - "documentation":"Describes a message about an Availability Zone.
" - }, - "AvailabilityZoneMessageList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZoneMessage", - "locationName":"item" - } - }, - "AvailabilityZoneState":{ - "type":"string", - "enum":["available"] - }, - "BlockDeviceMapping":{ - "type":"structure", - "members":{ - "VirtualName":{ - "shape":"String", - "documentation":"The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
", - "locationName":"virtualName" - }, - "DeviceName":{ - "shape":"String", - "documentation":"The device name exposed to the instance (for example, /dev/sdh).
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
", - "locationName":"ebs" - }, - "NoDevice":{ - "shape":"String", - "documentation":"Suppresses the specified device included in the block device mapping of the AMI.
", - "locationName":"noDevice" - } - }, - "documentation":"Describes a block device mapping.
" - }, - "BlockDeviceMappingList":{ - "type":"list", - "member":{ - "shape":"BlockDeviceMapping", - "locationName":"item" - } - }, - "BlockDeviceMappingRequestList":{ - "type":"list", - "member":{ - "shape":"BlockDeviceMapping", - "locationName":"BlockDeviceMapping" - } - }, - "Boolean":{"type":"boolean"}, - "BundleIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"BundleId" - } - }, - "BundleInstanceRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Storage" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
" - }, - "Storage":{ - "shape":"Storage", - "documentation":"The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
" - } - } - }, - "BundleInstanceResult":{ - "type":"structure", - "members":{ - "BundleTask":{ - "shape":"BundleTask", - "documentation":"Information about the bundle task.
", - "locationName":"bundleInstanceTask" - } - } - }, - "BundleTask":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance associated with this bundle task.
", - "locationName":"instanceId" - }, - "BundleId":{ - "shape":"String", - "documentation":"The ID of the bundle task.
", - "locationName":"bundleId" - }, - "State":{ - "shape":"BundleTaskState", - "documentation":"The state of the task.
", - "locationName":"state" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time this task started.
", - "locationName":"startTime" - }, - "UpdateTime":{ - "shape":"DateTime", - "documentation":"The time of the most recent update for the task.
", - "locationName":"updateTime" - }, - "Storage":{ - "shape":"Storage", - "documentation":"The Amazon S3 storage locations.
", - "locationName":"storage" - }, - "Progress":{ - "shape":"String", - "documentation":"The level of task completion, as a percent (for example, 20%).
", - "locationName":"progress" - }, - "BundleTaskError":{ - "shape":"BundleTaskError", - "documentation":"If the task fails, a description of the error.
", - "locationName":"error" - } - }, - "documentation":"Describes a bundle task.
" - }, - "BundleTaskError":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The error code.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"The error message.
", - "locationName":"message" - } - }, - "documentation":"Describes an error for BundleInstance.
" - }, - "BundleTaskList":{ - "type":"list", - "member":{ - "shape":"BundleTask", - "locationName":"item" - } - }, - "BundleTaskState":{ - "type":"string", - "enum":[ - "pending", - "waiting-for-shutdown", - "bundling", - "storing", - "cancelling", - "complete", - "failed" - ] - }, - "CancelBundleTaskRequest":{ - "type":"structure", - "required":["BundleId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "BundleId":{ - "shape":"String", - "documentation":"The ID of the bundle task.
" - } - } - }, - "CancelBundleTaskResult":{ - "type":"structure", - "members":{ - "BundleTask":{ - "shape":"BundleTask", - "documentation":"The bundle task.
", - "locationName":"bundleInstanceTask" - } - } - }, - "CancelConversionRequest":{ - "type":"structure", - "required":["ConversionTaskId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ConversionTaskId":{ - "shape":"String", - "documentation":"The ID of the conversion task.
", - "locationName":"conversionTaskId" - }, - "ReasonMessage":{ - "shape":"String", - "locationName":"reasonMessage" - } - } - }, - "CancelExportTaskRequest":{ - "type":"structure", - "required":["ExportTaskId"], - "members":{ - "ExportTaskId":{ - "shape":"String", - "documentation":"The ID of the export task. This is the ID returned by CreateInstanceExportTask.
The ID of the Reserved Instance listing.
", - "locationName":"reservedInstancesListingId" - } - } - }, - "CancelReservedInstancesListingResult":{ - "type":"structure", - "members":{ - "ReservedInstancesListings":{ - "shape":"ReservedInstancesListingList", - "documentation":"The Reserved Instance listing.
", - "locationName":"reservedInstancesListingsSet" - } - } - }, - "CancelSpotInstanceRequestState":{ - "type":"string", - "enum":[ - "active", - "open", - "closed", - "cancelled", - "completed" - ] - }, - "CancelSpotInstanceRequestsRequest":{ - "type":"structure", - "required":["SpotInstanceRequestIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SpotInstanceRequestIds":{ - "shape":"SpotInstanceRequestIdList", - "documentation":"One or more Spot Instance request IDs.
", - "locationName":"SpotInstanceRequestId" - } - } - }, - "CancelSpotInstanceRequestsResult":{ - "type":"structure", - "members":{ - "CancelledSpotInstanceRequests":{ - "shape":"CancelledSpotInstanceRequestList", - "documentation":"One or more Spot Instance requests.
", - "locationName":"spotInstanceRequestSet" - } - } - }, - "CancelledSpotInstanceRequest":{ - "type":"structure", - "members":{ - "SpotInstanceRequestId":{ - "shape":"String", - "documentation":"The ID of the Spot Instance request.
", - "locationName":"spotInstanceRequestId" - }, - "State":{ - "shape":"CancelSpotInstanceRequestState", - "documentation":"The state of the Spot Instance request.
", - "locationName":"state" - } - }, - "documentation":"Describes a request to cancel a Spot Instance.
" - }, - "CancelledSpotInstanceRequestList":{ - "type":"list", - "member":{ - "shape":"CancelledSpotInstanceRequest", - "locationName":"item" - } - }, - "ClassicLinkInstance":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"A list of security groups.
", - "locationName":"groupSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the instance.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a linked EC2-Classic instance.
" - }, - "ClassicLinkInstanceList":{ - "type":"list", - "member":{ - "shape":"ClassicLinkInstance", - "locationName":"item" - } - }, - "ConfirmProductInstanceRequest":{ - "type":"structure", - "required":[ - "ProductCode", - "InstanceId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ProductCode":{ - "shape":"String", - "documentation":"The product code. This must be a product code that you own.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - } - } - }, - "ConfirmProductInstanceResult":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.
", - "locationName":"ownerId" - } - } - }, - "ContainerFormat":{ - "type":"string", - "enum":["ova"] - }, - "ConversionIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"item" - } - }, - "ConversionTask":{ - "type":"structure", - "required":[ - "ConversionTaskId", - "State" - ], - "members":{ - "ConversionTaskId":{ - "shape":"String", - "documentation":"The ID of the conversion task.
", - "locationName":"conversionTaskId" - }, - "ExpirationTime":{ - "shape":"String", - "documentation":"The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
", - "locationName":"expirationTime" - }, - "ImportInstance":{ - "shape":"ImportInstanceTaskDetails", - "documentation":"If the task is for importing an instance, this contains information about the import instance task.
", - "locationName":"importInstance" - }, - "ImportVolume":{ - "shape":"ImportVolumeTaskDetails", - "documentation":"If the task is for importing a volume, this contains information about the import volume task.
", - "locationName":"importVolume" - }, - "State":{ - "shape":"ConversionTaskState", - "documentation":"The state of the conversion task.
", - "locationName":"state" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The status message related to the conversion task.
", - "locationName":"statusMessage" - }, - "Tags":{ - "shape":"TagList", - "locationName":"tagSet" - } - }, - "documentation":"Describes a conversion task.
" - }, - "ConversionTaskState":{ - "type":"string", - "enum":[ - "active", - "cancelling", - "cancelled", - "completed" - ] - }, - "CopyImageRequest":{ - "type":"structure", - "required":[ - "SourceRegion", - "SourceImageId", - "Name" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The name of the region that contains the AMI to copy.
" - }, - "SourceImageId":{ - "shape":"String", - "documentation":"The ID of the AMI to copy.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the new AMI in the destination region.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the new AMI in the destination region.
" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.
" - } - } - }, - "CopyImageResult":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the new AMI.
", - "locationName":"imageId" - } - } - }, - "CopySnapshotRequest":{ - "type":"structure", - "required":[ - "SourceRegion", - "SourceSnapshotId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The ID of the region that contains the snapshot to be copied.
" - }, - "SourceSnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot to copy.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the new Amazon EBS snapshot.
" - }, - "DestinationRegion":{ - "shape":"String", - "documentation":"The destination region of the snapshot copy operation. This parameter is required in the PresignedUrl.
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
The ID of the new snapshot.
", - "locationName":"snapshotId" - } - } - }, - "CreateCustomerGatewayRequest":{ - "type":"structure", - "required":[ - "Type", - "PublicIp", - "BgpAsn" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection that this customer gateway supports (ipsec.1).
The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
", - "locationName":"IpAddress" - }, - "BgpAsn":{ - "shape":"Integer", - "documentation":"For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
" - } - } - }, - "CreateCustomerGatewayResult":{ - "type":"structure", - "members":{ - "CustomerGateway":{ - "shape":"CustomerGateway", - "documentation":"Information about the customer gateway.
", - "locationName":"customerGateway" - } - } - }, - "CreateDhcpOptionsRequest":{ - "type":"structure", - "required":["DhcpConfigurations"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpConfigurations":{ - "shape":"NewDhcpConfigurationList", - "documentation":"A DHCP configuration option.
", - "locationName":"dhcpConfiguration" - } - } - }, - "CreateDhcpOptionsResult":{ - "type":"structure", - "members":{ - "DhcpOptions":{ - "shape":"DhcpOptions", - "documentation":"A set of DHCP options.
", - "locationName":"dhcpOptions" - } - } - }, - "CreateImageRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Name" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Name":{ - "shape":"String", - "documentation":"A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", - "locationName":"name" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the new image.
", - "locationName":"description" - }, - "NoReboot":{ - "shape":"Boolean", - "documentation":"By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
Information about one or more block device mappings.
", - "locationName":"blockDeviceMapping" - } - } - }, - "CreateImageResult":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the new AMI.
", - "locationName":"imageId" - } - } - }, - "CreateInstanceExportTaskRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "Description":{ - "shape":"String", - "documentation":"A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
", - "locationName":"description" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "TargetEnvironment":{ - "shape":"ExportEnvironment", - "documentation":"The target virtualization environment.
", - "locationName":"targetEnvironment" - }, - "ExportToS3Task":{ - "shape":"ExportToS3TaskSpecification", - "locationName":"exportToS3" - } - } - }, - "CreateInstanceExportTaskResult":{ - "type":"structure", - "members":{ - "ExportTask":{ - "shape":"ExportTask", - "locationName":"exportTask" - } - } - }, - "CreateInternetGatewayRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "CreateInternetGatewayResult":{ - "type":"structure", - "members":{ - "InternetGateway":{ - "shape":"InternetGateway", - "documentation":"Information about the Internet gateway.
", - "locationName":"internetGateway" - } - } - }, - "CreateKeyPairRequest":{ - "type":"structure", - "required":["KeyName"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyName":{ - "shape":"String", - "documentation":"A unique name for the key pair.
Constraints: Up to 255 ASCII characters
" - } - } - }, - "CreateNetworkAclEntryRequest":{ - "type":"structure", - "required":[ - "NetworkAclId", - "RuleNumber", - "Protocol", - "RuleAction", - "Egress", - "CidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766
", - "locationName":"ruleNumber" - }, - "Protocol":{ - "shape":"String", - "documentation":"The protocol. A value of -1 means all protocols.
", - "locationName":"protocol" - }, - "RuleAction":{ - "shape":"RuleAction", - "documentation":"Indicates whether to allow or deny the traffic that matches the rule.
", - "locationName":"ruleAction" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
", - "locationName":"egress" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.
", - "locationName":"Icmp" - }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to.
", - "locationName":"portRange" - } - } - }, - "CreateNetworkAclRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "CreateNetworkAclResult":{ - "type":"structure", - "members":{ - "NetworkAcl":{ - "shape":"NetworkAcl", - "documentation":"Information about the network ACL.
", - "locationName":"networkAcl" - } - } - }, - "CreateNetworkInterfaceRequest":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet to associate with the network interface.
", - "locationName":"subnetId" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the network interface.
", - "locationName":"description" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
The IDs of one or more security groups.
", - "locationName":"SecurityGroupId" - }, - "PrivateIpAddresses":{ - "shape":"PrivateIpAddressSpecificationList", - "documentation":"One or more private IP addresses.
", - "locationName":"privateIpAddresses" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide for Linux.
", - "locationName":"secondaryPrivateIpAddressCount" - }, - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "CreateNetworkInterfaceResult":{ - "type":"structure", - "members":{ - "NetworkInterface":{ - "shape":"NetworkInterface", - "documentation":"Information about the network interface.
", - "locationName":"networkInterface" - } - } - }, - "CreatePlacementGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "Strategy" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"A name for the placement group.
Constraints: Up to 255 ASCII characters
", - "locationName":"groupName" - }, - "Strategy":{ - "shape":"PlacementStrategy", - "documentation":"The placement strategy.
", - "locationName":"strategy" - } - } - }, - "CreateReservedInstancesListingRequest":{ - "type":"structure", - "required":[ - "ReservedInstancesId", - "InstanceCount", - "PriceSchedules", - "ClientToken" - ], - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the active Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
", - "locationName":"instanceCount" - }, - "PriceSchedules":{ - "shape":"PriceScheduleSpecificationList", - "documentation":"A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.
", - "locationName":"priceSchedules" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.
", - "locationName":"clientToken" - } - } - }, - "CreateReservedInstancesListingResult":{ - "type":"structure", - "members":{ - "ReservedInstancesListings":{ - "shape":"ReservedInstancesListingList", - "documentation":"Information about the Reserved Instances listing.
", - "locationName":"reservedInstancesListingsSet" - } - } - }, - "CreateRouteRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "DestinationCidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table for the route.
", - "locationName":"routeTableId" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
", - "locationName":"destinationCidrBlock" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of an Internet gateway or virtual private gateway attached to your VPC.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
", - "locationName":"instanceId" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of a network interface.
", - "locationName":"networkInterfaceId" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of a VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "CreateRouteTableRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "CreateRouteTableResult":{ - "type":"structure", - "members":{ - "RouteTable":{ - "shape":"RouteTable", - "documentation":"Information about the route table.
", - "locationName":"routeTable" - } - } - }, - "CreateSecurityGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "Description" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", - "locationName":"GroupDescription" - }, - "VpcId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
" - } - } - }, - "CreateSecurityGroupResult":{ - "type":"structure", - "members":{ - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - } - } - }, - "CreateSnapshotRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the snapshot.
" - } - } - }, - "CreateSpotDatafeedSubscriptionRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Bucket":{ - "shape":"String", - "documentation":"The Amazon S3 bucket in which to store the Spot Instance data feed.
", - "locationName":"bucket" - }, - "Prefix":{ - "shape":"String", - "documentation":"A prefix for the data feed file names.
", - "locationName":"prefix" - } - } - }, - "CreateSpotDatafeedSubscriptionResult":{ - "type":"structure", - "members":{ - "SpotDatafeedSubscription":{ - "shape":"SpotDatafeedSubscription", - "documentation":"The Spot Instance data feed subscription.
", - "locationName":"spotDatafeedSubscription" - } - } - }, - "CreateSubnetRequest":{ - "type":"structure", - "required":[ - "VpcId", - "CidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
The Availability Zone for the subnet.
Default: Amazon EC2 selects one for you (recommended).
" - } - } - }, - "CreateSubnetResult":{ - "type":"structure", - "members":{ - "Subnet":{ - "shape":"Subnet", - "documentation":"Information about the subnet.
", - "locationName":"subnet" - } - } - }, - "CreateTagsRequest":{ - "type":"structure", - "required":[ - "Resources", - "Tags" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Resources":{ - "shape":"ResourceIdList", - "documentation":"The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
", - "locationName":"ResourceId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.
", - "locationName":"userId" - }, - "Group":{ - "shape":"PermissionGroup", - "documentation":"The specific group that is to be added or removed from a volume's list of create volume permissions.
", - "locationName":"group" - } - } - }, - "CreateVolumePermissionList":{ - "type":"list", - "member":{ - "shape":"CreateVolumePermission", - "locationName":"item" - } - }, - "CreateVolumePermissionModifications":{ - "type":"structure", - "members":{ - "Add":{ - "shape":"CreateVolumePermissionList", - "documentation":"Adds a specific AWS account ID or group to a volume's list of create volume permissions.
" - }, - "Remove":{ - "shape":"CreateVolumePermissionList", - "documentation":"Removes a specific AWS account ID or group from a volume's list of create volume permissions.
" - } - } - }, - "CreateVolumeRequest":{ - "type":"structure", - "required":["AvailabilityZone"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Size":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiBs.
Constraints: If the volume type is io1, the minimum size of the volume is 4 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The snapshot from which to create the volume.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
" - }, - "VolumeType":{ - "shape":"VolumeType", - "documentation":"The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
Default: standard
Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume.
" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.
", - "locationName":"encrypted" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The full ARN of the AWS Key Management Service (KMS) master key to use when creating the encrypted volume. This parameter is only required if you want to use a non-default master key; if this parameter is not specified, the default master key is used. The ARN contains the arn:aws:kms namespace, followed by the region of the master key, the AWS account ID of the master key owner, the key namespace, and then the master key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
The ID of the requester VPC.
", - "locationName":"vpcId" - }, - "PeerVpcId":{ - "shape":"String", - "documentation":"The ID of the VPC with which you are creating the VPC peering connection.
", - "locationName":"peerVpcId" - }, - "PeerOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the peer VPC.
Default: Your AWS account ID
", - "locationName":"peerOwnerId" - } - } - }, - "CreateVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "VpcPeeringConnection":{ - "shape":"VpcPeeringConnection", - "documentation":"Information about the VPC peering connection.
", - "locationName":"vpcPeeringConnection" - } - } - }, - "CreateVpcRequest":{ - "type":"structure", - "required":["CidrBlock"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.
Default: default
Information about the VPC.
", - "locationName":"vpc" - } - } - }, - "CreateVpnConnectionRequest":{ - "type":"structure", - "required":[ - "Type", - "CustomerGatewayId", - "VpnGatewayId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Type":{ - "shape":"String", - "documentation":"The type of VPN connection (ipsec.1).
The ID of the customer gateway.
" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - }, - "Options":{ - "shape":"VpnConnectionOptionsSpecification", - "documentation":"Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.
Default: false
Information about the VPN connection.
", - "locationName":"vpnConnection" - } - } - }, - "CreateVpnConnectionRouteRequest":{ - "type":"structure", - "required":[ - "VpnConnectionId", - "DestinationCidrBlock" - ], - "members":{ - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block associated with the local subnet of the customer network.
" - } - } - }, - "CreateVpnGatewayRequest":{ - "type":"structure", - "required":["Type"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection this virtual private gateway supports.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the virtual private gateway.
" - } - } - }, - "CreateVpnGatewayResult":{ - "type":"structure", - "members":{ - "VpnGateway":{ - "shape":"VpnGateway", - "documentation":"Information about the virtual private gateway.
", - "locationName":"vpnGateway" - } - } - }, - "CurrencyCodeValues":{ - "type":"string", - "enum":["USD"] - }, - "CustomerGateway":{ - "type":"structure", - "members":{ - "CustomerGatewayId":{ - "shape":"String", - "documentation":"The ID of the customer gateway.
", - "locationName":"customerGatewayId" - }, - "State":{ - "shape":"String", - "documentation":"The current state of the customer gateway (pending | available | deleting | deleted).
The type of VPN connection the customer gateway supports (ipsec.1).
The Internet-routable IP address of the customer gateway's outside interface.
", - "locationName":"ipAddress" - }, - "BgpAsn":{ - "shape":"String", - "documentation":"The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
", - "locationName":"bgpAsn" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the customer gateway.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a customer gateway.
" - }, - "CustomerGatewayIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"CustomerGatewayId" - } - }, - "CustomerGatewayList":{ - "type":"list", - "member":{ - "shape":"CustomerGateway", - "locationName":"item" - } - }, - "DatafeedSubscriptionState":{ - "type":"string", - "enum":[ - "Active", - "Inactive" - ] - }, - "DateTime":{"type":"timestamp"}, - "DeleteCustomerGatewayRequest":{ - "type":"structure", - "required":["CustomerGatewayId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "CustomerGatewayId":{ - "shape":"String", - "documentation":"The ID of the customer gateway.
" - } - } - }, - "DeleteDhcpOptionsRequest":{ - "type":"structure", - "required":["DhcpOptionsId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the DHCP options set.
" - } - } - }, - "DeleteInternetGatewayRequest":{ - "type":"structure", - "required":["InternetGatewayId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InternetGatewayId":{ - "shape":"String", - "documentation":"The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - } - } - }, - "DeleteKeyPairRequest":{ - "type":"structure", - "required":["KeyName"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
" - } - } - }, - "DeleteNetworkAclEntryRequest":{ - "type":"structure", - "required":[ - "NetworkAclId", - "RuleNumber", - "Egress" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number of the entry to delete.
", - "locationName":"ruleNumber" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether the rule is an egress rule.
", - "locationName":"egress" - } - } - }, - "DeleteNetworkAclRequest":{ - "type":"structure", - "required":["NetworkAclId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - } - } - }, - "DeleteNetworkInterfaceRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - } - } - }, - "DeletePlacementGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group.
", - "locationName":"groupName" - } - } - }, - "DeleteRouteRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "DestinationCidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", - "locationName":"destinationCidrBlock" - } - } - }, - "DeleteRouteTableRequest":{ - "type":"structure", - "required":["RouteTableId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - } - } - }, - "DeleteSecurityGroupRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group. Required for a nondefault VPC.
" - } - } - }, - "DeleteSnapshotRequest":{ - "type":"structure", - "required":["SnapshotId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot.
" - } - } - }, - "DeleteSpotDatafeedSubscriptionRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "DeleteSubnetRequest":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
" - } - } - }, - "DeleteTagsRequest":{ - "type":"structure", - "required":["Resources"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Resources":{ - "shape":"ResourceIdList", - "documentation":"The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
", - "locationName":"resourceId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.
The ID of the volume.
" - } - } - }, - "DeleteVpcPeeringConnectionRequest":{ - "type":"structure", - "required":["VpcPeeringConnectionId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "DeleteVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the VPC.
" - } - } - }, - "DeleteVpnConnectionRequest":{ - "type":"structure", - "required":["VpnConnectionId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
" - } - } - }, - "DeleteVpnConnectionRouteRequest":{ - "type":"structure", - "required":[ - "VpnConnectionId", - "DestinationCidrBlock" - ], - "members":{ - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block associated with the local subnet of the customer network.
" - } - } - }, - "DeleteVpnGatewayRequest":{ - "type":"structure", - "required":["VpnGatewayId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - } - } - }, - "DeregisterImageRequest":{ - "type":"structure", - "required":["ImageId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - } - } - }, - "DescribeAccountAttributesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AttributeNames":{ - "shape":"AccountAttributeNameStringList", - "documentation":"One or more account attribute names.
", - "locationName":"attributeName" - } - } - }, - "DescribeAccountAttributesResult":{ - "type":"structure", - "members":{ - "AccountAttributes":{ - "shape":"AccountAttributeList", - "documentation":"Information about one or more account attributes.
", - "locationName":"accountAttributeSet" - } - } - }, - "DescribeAddressesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "PublicIps":{ - "shape":"PublicIpStringList", - "documentation":"[EC2-Classic] One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
", - "locationName":"PublicIp" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
[EC2-VPC] One or more allocation IDs.
Default: Describes all your Elastic IP addresses.
", - "locationName":"AllocationId" - } - } - }, - "DescribeAddressesResult":{ - "type":"structure", - "members":{ - "Addresses":{ - "shape":"AddressList", - "documentation":"Information about one or more Elastic IP addresses.
", - "locationName":"addressesSet" - } - } - }, - "DescribeAvailabilityZonesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ZoneNames":{ - "shape":"ZoneNameStringList", - "documentation":"The names of one or more Availability Zones.
", - "locationName":"ZoneName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
message - Information about the Availability Zone.
region-name - The name of the region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone (available | impaired | unavailable).
zone-name - The name of the Availability Zone (for example, us-east-1a).
Information about one or more Availability Zones.
", - "locationName":"availabilityZoneInfo" - } - } - }, - "DescribeBundleTasksRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "BundleIds":{ - "shape":"BundleIdStringList", - "documentation":"One or more bundle task IDs.
Default: Describes all your bundle tasks.
", - "locationName":"BundleId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
Information about one or more bundle tasks.
", - "locationName":"bundleInstanceTasksSet" - } - } - }, - "DescribeClassicLinkInstancesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
", - "locationName":"InstanceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC that the instance is linked to.
The token for the next set of items to return. (You received this token from a prior call.)
", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1000, we return only 1000 items.
", - "locationName":"maxResults" - } - } - }, - "DescribeClassicLinkInstancesResult":{ - "type":"structure", - "members":{ - "Instances":{ - "shape":"ClassicLinkInstanceList", - "documentation":"Information about one or more linked EC2-Classic instances.
", - "locationName":"instancesSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", - "locationName":"nextToken" - } - } - }, - "DescribeConversionTaskList":{ - "type":"list", - "member":{ - "shape":"ConversionTask", - "locationName":"item" - } - }, - "DescribeConversionTasksRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Filters":{ - "shape":"FilterList", - "locationName":"filter" - }, - "ConversionTaskIds":{ - "shape":"ConversionIdStringList", - "documentation":"One or more conversion task IDs.
", - "locationName":"conversionTaskId" - } - } - }, - "DescribeConversionTasksResult":{ - "type":"structure", - "members":{ - "ConversionTasks":{ - "shape":"DescribeConversionTaskList", - "locationName":"conversionTasks" - } - } - }, - "DescribeCustomerGatewaysRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "CustomerGatewayIds":{ - "shape":"CustomerGatewayIdStringList", - "documentation":"One or more customer gateway IDs.
Default: Describes all your customer gateways.
", - "locationName":"CustomerGatewayId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
Information about one or more customer gateways.
", - "locationName":"customerGatewaySet" - } - } - }, - "DescribeDhcpOptionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "DhcpOptionsIds":{ - "shape":"DhcpOptionsIdStringList", - "documentation":"The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
", - "locationName":"DhcpOptionsId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
dhcp-options-id - The ID of a set of DHCP options.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
Information about one or more DHCP options sets.
", - "locationName":"dhcpOptionsSet" - } - } - }, - "DescribeExportTasksRequest":{ - "type":"structure", - "members":{ - "ExportTaskIds":{ - "shape":"ExportTaskIdStringList", - "documentation":"One or more export task IDs.
", - "locationName":"exportTaskId" - } - } - }, - "DescribeExportTasksResult":{ - "type":"structure", - "members":{ - "ExportTasks":{ - "shape":"ExportTaskList", - "locationName":"exportTaskSet" - } - } - }, - "DescribeImageAttributeRequest":{ - "type":"structure", - "required":[ - "ImageId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - }, - "Attribute":{ - "shape":"ImageAttributeName", - "documentation":"The AMI attribute.
" - } - } - }, - "DescribeImagesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageIds":{ - "shape":"ImageIdStringList", - "documentation":"One or more image IDs.
Default: Describes all images available to you.
", - "locationName":"ImageId" - }, - "Owners":{ - "shape":"OwnerStringList", - "documentation":"Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
One or more filters.
architecture - The image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).
description - The description of the image (provided during image creation).
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The AWS account alias (for example, amazon).
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
virtualization-type - The virtualization type (paravirtual | hvm).
Information about one or more images.
", - "locationName":"imagesSet" - } - } - }, - "DescribeInstanceAttributeRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The instance attribute.
", - "locationName":"attribute" - } - } - }, - "DescribeInstanceStatusRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
", - "locationName":"InstanceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone - The Availability Zone of the instance.
event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.
event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.
instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The next paginated set of results to return. (You received this token from a prior call.)
" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of paginated instance items per response. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
Default: 1000
" - }, - "IncludeAllInstances":{ - "shape":"Boolean", - "documentation":"When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
One or more instance status descriptions.
", - "locationName":"instanceStatusSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next paginated set of results to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeInstancesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
Default: Describes all your instances.
", - "locationName":"InstanceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
architecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hypervisor - The hypervisor type of the instance (ovm | xen).
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance (spot).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, m1.small).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IP address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private DNS name of the instance.
private-ip-address - The private IP address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.
root-device-name - The name of the root device for the instance (for example, /dev/sda1).
root-device-type - The type of root device that the instance uses (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
tenancy - The tenancy of an instance (dedicated | default).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
network-interface.description - The description of the network interface.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
network-interface.network-interface.id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.mac-address - The MAC address of the network interface.
network-interface-private-dns-name - The private DNS name of the network interface.
network-interface.source-destination-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
The token for the next set of items to return. (You received this token from a prior call.)
", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
", - "locationName":"maxResults" - } - } - }, - "DescribeInstancesResult":{ - "type":"structure", - "members":{ - "Reservations":{ - "shape":"ReservationList", - "documentation":"One or more reservations.
", - "locationName":"reservationSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", - "locationName":"nextToken" - } - } - }, - "DescribeInternetGatewaysRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InternetGatewayIds":{ - "shape":"ValueStringList", - "documentation":"One or more Internet gateway IDs.
Default: Describes all your Internet gateways.
", - "locationName":"internetGatewayId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
Information about one or more Internet gateways.
", - "locationName":"internetGatewaySet" - } - } - }, - "DescribeKeyPairsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyNames":{ - "shape":"KeyNameStringList", - "documentation":"One or more key pair names.
Default: Describes all your key pairs.
", - "locationName":"KeyName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
Information about one or more key pairs.
", - "locationName":"keySet" - } - } - }, - "DescribeNetworkAclsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclIds":{ - "shape":"ValueStringList", - "documentation":"One or more network ACL IDs.
Default: Describes all your network ACLs.
", - "locationName":"NetworkAclId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The CIDR range specified in the entry.
entry.egress - Indicates whether the entry applies to egress traffic.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.
network-acl-id - The ID of the network ACL.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network ACL.
Information about one or more network ACLs.
", - "locationName":"networkAclSet" - } - } - }, - "DescribeNetworkInterfaceAttributeRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "Attribute":{ - "shape":"NetworkInterfaceAttribute", - "documentation":"The attribute of the network interface.
", - "locationName":"attribute" - } - } - }, - "DescribeNetworkInterfaceAttributeResult":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "Description":{ - "shape":"AttributeValue", - "documentation":"The description of the network interface.
", - "locationName":"description" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether source/destination checking is enabled.
", - "locationName":"sourceDestCheck" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"The security groups associated with the network interface.
", - "locationName":"groupSet" - }, - "Attachment":{ - "shape":"NetworkInterfaceAttachment", - "documentation":"The attachment (if any) of the network interface.
", - "locationName":"attachment" - } - } - }, - "DescribeNetworkInterfacesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceIds":{ - "shape":"NetworkInterfaceIdList", - "documentation":"One or more network interface IDs.
Default: Describes all your network interfaces.
", - "locationName":"NetworkInterfaceId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
addresses.private-ip-address - The private IP addresses associated with the network interface.
addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.public-dns-name - The public DNS name for the network interface.
attachment.attachment-id - The ID of the interface attachment.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.device-index - The device index to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
attachment.attach.time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IP address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network interface.
Information about one or more network interfaces.
", - "locationName":"networkInterfaceSet" - } - } - }, - "DescribePlacementGroupsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupNames":{ - "shape":"PlacementGroupStringList", - "documentation":"One or more placement group names.
Default: Describes all your placement groups, or only those otherwise specified.
", - "locationName":"groupName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster).
One or more placement groups.
", - "locationName":"placementGroupSet" - } - } - }, - "DescribeRegionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RegionNames":{ - "shape":"RegionNameStringList", - "documentation":"The names of one or more regions.
", - "locationName":"RegionName" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for example, us-east-1).
Information about one or more regions.
", - "locationName":"regionInfo" - } - } - }, - "DescribeReservedInstancesListingsRequest":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"One or more Reserved Instance IDs.
", - "locationName":"reservedInstancesId" - }, - "ReservedInstancesListingId":{ - "shape":"String", - "documentation":"One or more Reserved Instance Listing IDs.
", - "locationName":"reservedInstancesListingId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
Information about the Reserved Instance listing.
", - "locationName":"reservedInstancesListingsSet" - } - } - }, - "DescribeReservedInstancesModificationsRequest":{ - "type":"structure", - "members":{ - "ReservedInstancesModificationIds":{ - "shape":"ReservedInstancesModificationIdStringList", - "documentation":"IDs for the submitted modification request.
", - "locationName":"ReservedInstancesModificationId" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token for the next page of data.
", - "locationName":"nextToken" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
The Reserved Instance modification information.
", - "locationName":"reservedInstancesModificationsSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token for the next page of data.
", - "locationName":"nextToken" - } - } - }, - "DescribeReservedInstancesOfferingsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ReservedInstancesOfferingIds":{ - "shape":"ReservedInstancesOfferingIdStringList", - "documentation":"One or more Reserved Instances offering IDs.
", - "locationName":"ReservedInstancesOfferingId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.
product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).
reserved-instances-offering-id - The Reserved Instances offering ID.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.
Default: default
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
The token to use when requesting the next paginated set of offerings.
", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of offerings to return. The maximum is 100.
Default: 100
", - "locationName":"maxResults" - }, - "IncludeMarketplace":{ - "shape":"Boolean", - "documentation":"Include Marketplace offerings in the response.
" - }, - "MinDuration":{ - "shape":"Long", - "documentation":"The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
" - }, - "MaxDuration":{ - "shape":"Long", - "documentation":"The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
" - }, - "MaxInstanceCount":{ - "shape":"Integer", - "documentation":"The maximum number of instances to filter when searching for offerings.
Default: 20
" - } - } - }, - "DescribeReservedInstancesOfferingsResult":{ - "type":"structure", - "members":{ - "ReservedInstancesOfferings":{ - "shape":"ReservedInstancesOfferingList", - "documentation":"A list of Reserved Instances offerings.
", - "locationName":"reservedInstancesOfferingsSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next paginated set of results to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeReservedInstancesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ReservedInstancesIds":{ - "shape":"ReservedInstancesIdStringList", - "documentation":"One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
", - "locationName":"ReservedInstancesId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
A list of Reserved Instances.
", - "locationName":"reservedInstancesSet" - } - } - }, - "DescribeRouteTablesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableIds":{ - "shape":"ValueStringList", - "documentation":"One or more route table IDs.
Default: Describes all your route tables.
", - "locationName":"RouteTableId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC.
route-table-id - The ID of the route table.
route.destination-cidr-block - The CIDR range specified in a route in the table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the route table.
Information about one or more route tables.
", - "locationName":"routeTableSet" - } - } - }, - "DescribeSecurityGroupsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupNames":{ - "shape":"GroupNameStringList", - "documentation":"[EC2-Classic, default VPC] One or more security group names. You can specify either the security group name or the security group ID.
Default: Describes all your security groups.
", - "locationName":"GroupName" - }, - "GroupIds":{ - "shape":"GroupIdStringList", - "documentation":"One or more security group IDs. Required for nondefault VPCs.
Default: Describes all your security groups.
", - "locationName":"GroupId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
description - The description of the security group.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - A CIDR range that has been granted permission.
ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been granted permission.
ip-permission.group-name - The name of a security group that has been granted permission.
ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).
ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been granted permission.
owner-id - The AWS account ID of the owner of the security group.
tag-key - The key of a tag assigned to the security group.
tag-value - The value of a tag assigned to the security group.
vpc-id - The ID of the VPC specified when the security group was created.
Information about one or more security groups.
", - "locationName":"securityGroupInfo" - } - } - }, - "DescribeSnapshotAttributeRequest":{ - "type":"structure", - "required":[ - "SnapshotId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot.
" - }, - "Attribute":{ - "shape":"SnapshotAttributeName", - "documentation":"The snapshot attribute you would like to view.
" - } - } - }, - "DescribeSnapshotAttributeResult":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS snapshot.
", - "locationName":"snapshotId" - }, - "CreateVolumePermissions":{ - "shape":"CreateVolumePermissionList", - "documentation":"A list of permissions for creating volumes from the snapshot.
", - "locationName":"createVolumePermission" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"A list of product codes.
", - "locationName":"productCodes" - } - } - }, - "DescribeSnapshotsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotIds":{ - "shape":"SnapshotIdStringList", - "documentation":"One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
", - "locationName":"SnapshotId" - }, - "OwnerIds":{ - "shape":"OwnerStringList", - "documentation":"Returns the snapshots owned by the specified owner. Multiple owners can be specified.
", - "locationName":"Owner" - }, - "RestorableByUserIds":{ - "shape":"RestorableByStringList", - "documentation":"One or more AWS accounts IDs that can create volumes from the snapshot.
", - "locationName":"RestorableBy" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
description - A description of the snapshot.
owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
The Spot Instance data feed subscription.
", - "locationName":"spotDatafeedSubscription" - } - } - }, - "DescribeSpotInstanceRequestsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SpotInstanceRequestIds":{ - "shape":"SpotInstanceRequestIdList", - "documentation":"One or more Spot Instance request IDs.
", - "locationName":"SpotInstanceRequestId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).
launch.group-id - The security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m1.small).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
network-interface.network-interface-id - The ID of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.subnet-id - The ID of the subnet for the instance.
network-interface.description - A description of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.group-name - The name of the security group associated with the network interface.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of Spot Instance request (one-time | persistent).
launched-availability-zone - The Availability Zone in which the bid is launched.
valid-from - The start date of the request.
valid-until - The end date of the request.
One or more Spot Instance requests.
", - "locationName":"spotInstanceRequestSet" - } - } - }, - "DescribeSpotPriceHistoryRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The start date and time of the Spot Price history data.
", - "locationName":"startTime" - }, - "EndTime":{ - "shape":"DateTime", - "documentation":"The end date and time of the Spot Price history data.
", - "locationName":"endTime" - }, - "InstanceTypes":{ - "shape":"InstanceTypeList", - "documentation":"One or more instance types.
", - "locationName":"InstanceType" - }, - "ProductDescriptions":{ - "shape":"ProductDescriptionList", - "documentation":"One or more basic product descriptions.
", - "locationName":"ProductDescription" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m1.small).
product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
The Availability Zone.
", - "locationName":"availabilityZone" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The number of rows to return.
", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next set of rows to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeSpotPriceHistoryResult":{ - "type":"structure", - "members":{ - "SpotPriceHistory":{ - "shape":"SpotPriceHistoryList", - "documentation":"The historical Spot Prices.
", - "locationName":"spotPriceHistorySet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The string marking the next set of results. This is empty if there are no more results.
", - "locationName":"nextToken" - } - } - }, - "DescribeSubnetsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SubnetIds":{ - "shape":"SubnetIdStringList", - "documentation":"One or more subnet IDs.
Default: Describes all your subnets.
", - "locationName":"SubnetId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.
available-ip-address-count - The number of IP addresses in the subnet that are available.
cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.
defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.
state - The state of the subnet (pending | available).
subnet-id - The ID of the subnet.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the subnet.
Information about one or more subnets.
", - "locationName":"subnetSet" - } - } - }, - "DescribeTagsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
key - The tag key.
resource-id - The resource ID.
resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).
value - The tag value.
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.
", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token for the next set of items to return. (You received this token from a prior call.)
", - "locationName":"nextToken" - } - } - }, - "DescribeTagsResult":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagDescriptionList", - "documentation":"A list of tags.
", - "locationName":"tagSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", - "locationName":"nextToken" - } - } - }, - "DescribeVolumeAttributeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
" - }, - "Attribute":{ - "shape":"VolumeAttributeName", - "documentation":"The instance attribute.
" - } - } - }, - "DescribeVolumeAttributeResult":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "AutoEnableIO":{ - "shape":"AttributeBooleanValue", - "documentation":"The state of autoEnableIO attribute.
A list of product codes.
", - "locationName":"productCodes" - } - } - }, - "DescribeVolumeStatusRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeIds":{ - "shape":"VolumeIdStringList", - "documentation":"One or more volume IDs.
Default: Describes all your volumes.
", - "locationName":"VolumeId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The next paginated set of results to return using the pagination token returned by a previous call.
" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"The maximum number of paginated volume items per response.
" - } - } - }, - "DescribeVolumeStatusResult":{ - "type":"structure", - "members":{ - "VolumeStatuses":{ - "shape":"VolumeStatusList", - "documentation":"A list of volumes.
", - "locationName":"volumeStatusSet" - }, - "NextToken":{ - "shape":"String", - "documentation":"The next paginated set of results to return.
", - "locationName":"nextToken" - } - } - }, - "DescribeVolumesRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeIds":{ - "shape":"VolumeIdStringList", - "documentation":"One or more volume IDs.
", - "locationName":"VolumeId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching | detached).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status of the volume (creating | available | in-use | deleting | deleted | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results.
The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the VPC.
" - }, - "Attribute":{ - "shape":"VpcAttributeName", - "documentation":"The VPC attribute.
" - } - } - }, - "DescribeVpcAttributeResult":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "EnableDnsSupport":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
One or more VPCs for which you want to describe the ClassicLink status.
", - "locationName":"VpcId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ClassicLink status of one or more VPCs.
", - "locationName":"vpcSet" - } - } - }, - "DescribeVpcPeeringConnectionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionIds":{ - "shape":"ValueStringList", - "documentation":"One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
", - "locationName":"VpcPeeringConnectionId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.
accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id - The ID of the peer VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-peering-connection-id - The ID of the VPC peering connection.
Information about the VPC peering connections.
", - "locationName":"vpcPeeringConnectionSet" - } - } - }, - "DescribeVpcsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcIds":{ - "shape":"VpcIdStringList", - "documentation":"One or more VPC IDs.
Default: Describes all your VPCs.
", - "locationName":"VpcId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
dhcp-options-id - The ID of a set of DHCP options.
isDefault - Indicates whether the VPC is the default VPC.
state - The state of the VPC (pending | available).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC.
Information about one or more VPCs.
", - "locationName":"vpcSet" - } - } - }, - "DescribeVpnConnectionsRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnConnectionIds":{ - "shape":"VpnConnectionIdStringList", - "documentation":"One or more VPN connection IDs.
Default: Describes your VPN connections.
", - "locationName":"VpnConnectionId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
Information about one or more VPN connections.
", - "locationName":"vpnConnectionSet" - } - } - }, - "DescribeVpnGatewaysRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnGatewayIds":{ - "shape":"VpnGatewayIdStringList", - "documentation":"One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
", - "locationName":"VpnGatewayId" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway.
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
Information about one or more virtual private gateways.
", - "locationName":"vpnGatewaySet" - } - } - }, - "DetachClassicLinkVpcRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance to unlink from the VPC.
", - "locationName":"instanceId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC to which the instance is linked.
", - "locationName":"vpcId" - } - } - }, - "DetachClassicLinkVpcResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "DetachNetworkInterfaceRequest":{ - "type":"structure", - "required":["AttachmentId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the attachment.
", - "locationName":"attachmentId" - }, - "Force":{ - "shape":"Boolean", - "documentation":"Specifies whether to force a detachment.
", - "locationName":"force" - } - } - }, - "DetachVolumeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - }, - "Device":{ - "shape":"String", - "documentation":"The device name.
" - }, - "Force":{ - "shape":"Boolean", - "documentation":"Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
" - } - } - }, - "DetachVpnGatewayRequest":{ - "type":"structure", - "required":[ - "VpnGatewayId", - "VpcId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
" - } - } - }, - "DeviceType":{ - "type":"string", - "enum":[ - "ebs", - "instance-store" - ] - }, - "DhcpConfiguration":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"The name of a DHCP option.
", - "locationName":"key" - }, - "Values":{ - "shape":"DhcpConfigurationValueList", - "documentation":"One or more values for the DHCP option.
", - "locationName":"valueSet" - } - }, - "documentation":"Describes a DHCP configuration option.
" - }, - "DhcpConfigurationList":{ - "type":"list", - "member":{ - "shape":"DhcpConfiguration", - "locationName":"item" - } - }, - "DhcpOptions":{ - "type":"structure", - "members":{ - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the set of DHCP options.
", - "locationName":"dhcpOptionsId" - }, - "DhcpConfigurations":{ - "shape":"DhcpConfigurationList", - "documentation":"One or more DHCP options in the set.
", - "locationName":"dhcpConfigurationSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the DHCP options set.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a set of DHCP options.
" - }, - "DhcpOptionsIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"DhcpOptionsId" - } - }, - "DhcpOptionsList":{ - "type":"list", - "member":{ - "shape":"DhcpOptions", - "locationName":"item" - } - }, - "DisableVgwRoutePropagationRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "GatewayId" - ], - "members":{ - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - } - } - }, - "DisableVpcClassicLinkRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "DisableVpcClassicLinkResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" - }, - "AssociationId":{ - "shape":"String", - "documentation":"[EC2-VPC] The association ID. Required for EC2-VPC.
" - } - } - }, - "DisassociateRouteTableRequest":{ - "type":"structure", - "required":["AssociationId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The association ID representing the current association between the route table and subnet.
", - "locationName":"associationId" - } - } - }, - "DiskImage":{ - "type":"structure", - "members":{ - "Image":{"shape":"DiskImageDetail"}, - "Description":{"shape":"String"}, - "Volume":{"shape":"VolumeDetail"} - }, - "documentation":"Describes a disk image.
" - }, - "DiskImageDescription":{ - "type":"structure", - "required":[ - "Format", - "Size", - "ImportManifestUrl" - ], - "members":{ - "Format":{ - "shape":"DiskImageFormat", - "documentation":"The disk image format.
", - "locationName":"format" - }, - "Size":{ - "shape":"Long", - "documentation":"The size of the disk image.
", - "locationName":"size" - }, - "ImportManifestUrl":{ - "shape":"String", - "documentation":"A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
", - "locationName":"importManifestUrl" - }, - "Checksum":{ - "shape":"String", - "documentation":"The checksum computed for the disk image.
", - "locationName":"checksum" - } - } - }, - "DiskImageDetail":{ - "type":"structure", - "required":[ - "Format", - "Bytes", - "ImportManifestUrl" - ], - "members":{ - "Format":{ - "shape":"DiskImageFormat", - "documentation":"The disk image format.
", - "locationName":"format" - }, - "Bytes":{ - "shape":"Long", - "locationName":"bytes" - }, - "ImportManifestUrl":{ - "shape":"String", - "documentation":"A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
", - "locationName":"importManifestUrl" - } - } - }, - "DiskImageFormat":{ - "type":"string", - "enum":[ - "VMDK", - "RAW", - "VHD" - ] - }, - "DiskImageList":{ - "type":"list", - "member":{"shape":"DiskImage"} - }, - "DiskImageVolumeDescription":{ - "type":"structure", - "required":["Id"], - "members":{ - "Size":{ - "shape":"Long", - "documentation":"The size of the volume.
", - "locationName":"size" - }, - "Id":{ - "shape":"String", - "documentation":"The volume identifier.
", - "locationName":"id" - } - } - }, - "DomainType":{ - "type":"string", - "enum":[ - "vpc", - "standard" - ] - }, - "Double":{"type":"double"}, - "EbsBlockDevice":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot.
", - "locationName":"snapshotId" - }, - "VolumeSize":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiB.
Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
", - "locationName":"volumeSize" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the Amazon EBS volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - }, - "VolumeType":{ - "shape":"VolumeType", - "documentation":"The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
", - "locationName":"encrypted" - } - }, - "documentation":"Describes an Amazon EBS block device.
" - }, - "EbsInstanceBlockDevice":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume.
", - "locationName":"volumeId" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"The attachment state.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes a parameter used to set up an Amazon EBS volume in a block device mapping.
" - }, - "EbsInstanceBlockDeviceSpecification":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the Amazon EBS volume.
", - "locationName":"volumeId" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - } - } - }, - "EnableVgwRoutePropagationRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "GatewayId" - ], - "members":{ - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
" - } - } - }, - "EnableVolumeIORequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - } - } - }, - "EnableVpcClassicLinkRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - } - }, - "EnableVpcClassicLinkResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the export task.
", - "locationName":"exportTaskId" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the resource being exported.
", - "locationName":"description" - }, - "State":{ - "shape":"ExportTaskState", - "documentation":"The state of the conversion task.
", - "locationName":"state" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The status message related to the export task.
", - "locationName":"statusMessage" - }, - "InstanceExportDetails":{ - "shape":"InstanceExportDetails", - "documentation":"The instance being exported.
", - "locationName":"instanceExport" - }, - "ExportToS3Task":{ - "shape":"ExportToS3Task", - "locationName":"exportToS3" - } - }, - "documentation":"Describes an export task.
" - }, - "ExportTaskIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ExportTaskId" - } - }, - "ExportTaskList":{ - "type":"list", - "member":{ - "shape":"ExportTask", - "locationName":"item" - } - }, - "ExportTaskState":{ - "type":"string", - "enum":[ - "active", - "cancelling", - "cancelled", - "completed" - ] - }, - "ExportToS3Task":{ - "type":"structure", - "members":{ - "DiskImageFormat":{ - "shape":"DiskImageFormat", - "documentation":"The format for the exported image.
", - "locationName":"diskImageFormat" - }, - "ContainerFormat":{ - "shape":"ContainerFormat", - "documentation":"The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
", - "locationName":"containerFormat" - }, - "S3Bucket":{ - "shape":"String", - "documentation":"The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACL permissions to the AWS account vm-import-export@amazon.com.
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
", - "locationName":"s3Prefix" - } - } - }, - "Filter":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the filter. Filter names are case-sensitive.
" - }, - "Values":{ - "shape":"ValueStringList", - "documentation":"One or more filter values. Filter values are case-sensitive.
", - "locationName":"Value" - } - }, - "documentation":"A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
" - }, - "FilterList":{ - "type":"list", - "member":{ - "shape":"Filter", - "locationName":"Filter" - } - }, - "Float":{"type":"float"}, - "GatewayType":{ - "type":"string", - "enum":["ipsec.1"] - }, - "GetConsoleOutputRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
" - } - } - }, - "GetConsoleOutputResult":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Timestamp":{ - "shape":"DateTime", - "documentation":"The time the output was last updated.
", - "locationName":"timestamp" - }, - "Output":{ - "shape":"String", - "documentation":"The console output, Base64 encoded.
", - "locationName":"output" - } - } - }, - "GetPasswordDataRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the Windows instance.
" - } - } - }, - "GetPasswordDataResult":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the Windows instance.
", - "locationName":"instanceId" - }, - "Timestamp":{ - "shape":"DateTime", - "documentation":"The time the data was last updated.
", - "locationName":"timestamp" - }, - "PasswordData":{ - "shape":"String", - "documentation":"The password of the instance.
", - "locationName":"passwordData" - } - } - }, - "GroupIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"groupId" - } - }, - "GroupIdentifier":{ - "type":"structure", - "members":{ - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
", - "locationName":"groupName" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - } - }, - "documentation":"Describes a security group.
" - }, - "GroupIdentifierList":{ - "type":"list", - "member":{ - "shape":"GroupIdentifier", - "locationName":"item" - } - }, - "GroupNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"GroupName" - } - }, - "HypervisorType":{ - "type":"string", - "enum":[ - "ovm", - "xen" - ] - }, - "IamInstanceProfile":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the instance profile.
", - "locationName":"arn" - }, - "Id":{ - "shape":"String", - "documentation":"The ID of the instance profile.
", - "locationName":"id" - } - }, - "documentation":"Describes an IAM instance profile.
" - }, - "IamInstanceProfileSpecification":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the instance profile.
", - "locationName":"arn" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the instance profile.
", - "locationName":"name" - } - }, - "documentation":"Describes an IAM instance profile.
" - }, - "IcmpTypeCode":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"Integer", - "documentation":"The ICMP code. A value of -1 means all codes for the specified ICMP type.
", - "locationName":"type" - }, - "Code":{ - "shape":"Integer", - "documentation":"The ICMP type. A value of -1 means all types.
", - "locationName":"code" - } - }, - "documentation":"Describes the ICMP type and code.
" - }, - "Image":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "ImageLocation":{ - "shape":"String", - "documentation":"The location of the AMI.
", - "locationName":"imageLocation" - }, - "State":{ - "shape":"ImageState", - "documentation":"The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The AWS account ID of the image owner.
", - "locationName":"imageOwnerId" - }, - "CreationDate":{ - "shape":"String", - "documentation":"The date and time the image was created.
", - "locationName":"creationDate" - }, - "Public":{ - "shape":"Boolean", - "documentation":"Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
Any product codes associated with the AMI.
", - "locationName":"productCodes" - }, - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the image.
", - "locationName":"architecture" - }, - "ImageType":{ - "shape":"ImageTypeValues", - "documentation":"The type of image.
", - "locationName":"imageType" - }, - "KernelId":{ - "shape":"String", - "documentation":"The kernel associated with the image, if any. Only applicable for machine images.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The RAM disk associated with the image, if any. Only applicable for machine images.
", - "locationName":"ramdiskId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The value is Windows for Windows AMIs; otherwise blank.
Specifies whether enhanced networking is enabled.
", - "locationName":"sriovNetSupport" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"The reason for the state change.
", - "locationName":"stateReason" - }, - "ImageOwnerAlias":{ - "shape":"String", - "documentation":"The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
The name of the AMI that was provided during image creation.
", - "locationName":"name" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the AMI that was provided during image creation.
", - "locationName":"description" - }, - "RootDeviceType":{ - "shape":"DeviceType", - "documentation":"The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
", - "locationName":"rootDeviceType" - }, - "RootDeviceName":{ - "shape":"String", - "documentation":"The device name of the root device (for example,
Any block device mapping entries.
", - "locationName":"blockDeviceMapping" - }, - "VirtualizationType":{ - "shape":"VirtualizationType", - "documentation":"The type of virtualization of the AMI.
", - "locationName":"virtualizationType" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the image.
", - "locationName":"tagSet" - }, - "Hypervisor":{ - "shape":"HypervisorType", - "documentation":"The hypervisor type of the image.
", - "locationName":"hypervisor" - } - }, - "documentation":"Describes an image.
" - }, - "ImageAttribute":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "LaunchPermissions":{ - "shape":"LaunchPermissionList", - "documentation":"One or more launch permissions.
", - "locationName":"launchPermission" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"One or more product codes.
", - "locationName":"productCodes" - }, - "KernelId":{ - "shape":"AttributeValue", - "documentation":"The kernel ID.
", - "locationName":"kernel" - }, - "RamdiskId":{ - "shape":"AttributeValue", - "documentation":"The RAM disk ID.
", - "locationName":"ramdisk" - }, - "Description":{ - "shape":"AttributeValue", - "documentation":"A description for the AMI.
", - "locationName":"description" - }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "locationName":"sriovNetSupport" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"One or more block device mapping entries.
", - "locationName":"blockDeviceMapping" - } - }, - "documentation":"Describes an image attribute.
" - }, - "ImageAttributeName":{ - "type":"string", - "enum":[ - "description", - "kernel", - "ramdisk", - "launchPermission", - "productCodes", - "blockDeviceMapping" - ] - }, - "ImageIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ImageId" - } - }, - "ImageList":{ - "type":"list", - "member":{ - "shape":"Image", - "locationName":"item" - } - }, - "ImageState":{ - "type":"string", - "enum":[ - "available", - "deregistered" - ] - }, - "ImageTypeValues":{ - "type":"string", - "enum":[ - "machine", - "kernel", - "ramdisk" - ] - }, - "ImportInstanceLaunchSpecification":{ - "type":"structure", - "members":{ - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the instance.
", - "locationName":"architecture" - }, - "GroupNames":{ - "shape":"SecurityGroupStringList", - "documentation":"One or more security group names.
", - "locationName":"GroupName" - }, - "GroupIds":{ - "shape":"SecurityGroupIdStringList", - "documentation":"One or more security group IDs.
", - "locationName":"GroupId" - }, - "AdditionalInfo":{ - "shape":"String", - "locationName":"additionalInfo" - }, - "UserData":{ - "shape":"UserData", - "documentation":"User data to be made available to the instance.
", - "locationName":"userData" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can specify another security group using the AWS Management Console. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about the Linux instance types you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide for Linux.
", - "locationName":"instanceType" - }, - "Placement":{ - "shape":"Placement", - "locationName":"placement" - }, - "Monitoring":{ - "shape":"Boolean", - "locationName":"monitoring" - }, - "SubnetId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the subnet to launch the instance into.
", - "locationName":"subnetId" - }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"ShutdownBehavior", - "documentation":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.
", - "locationName":"privateIpAddress" - } - } - }, - "ImportInstanceRequest":{ - "type":"structure", - "required":["Platform"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Description":{ - "shape":"String", - "documentation":"A description for the instance being imported.
", - "locationName":"description" - }, - "LaunchSpecification":{ - "shape":"ImportInstanceLaunchSpecification", - "documentation":"", - "locationName":"launchSpecification" - }, - "DiskImages":{ - "shape":"DiskImageList", - "locationName":"diskImage" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The instance operating system.
", - "locationName":"platform" - } - } - }, - "ImportInstanceResult":{ - "type":"structure", - "members":{ - "ConversionTask":{ - "shape":"ConversionTask", - "locationName":"conversionTask" - } - } - }, - "ImportInstanceTaskDetails":{ - "type":"structure", - "required":["Volumes"], - "members":{ - "Volumes":{ - "shape":"ImportInstanceVolumeDetailSet", - "locationName":"volumes" - }, - "InstanceId":{ - "shape":"String", - "locationName":"instanceId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The instance operating system.
", - "locationName":"platform" - }, - "Description":{ - "shape":"String", - "locationName":"description" - } - } - }, - "ImportInstanceVolumeDetailItem":{ - "type":"structure", - "required":[ - "BytesConverted", - "AvailabilityZone", - "Image", - "Volume", - "Status" - ], - "members":{ - "BytesConverted":{ - "shape":"Long", - "documentation":"The number of bytes converted so far.
", - "locationName":"bytesConverted" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where the resulting instance will reside.
", - "locationName":"availabilityZone" - }, - "Image":{ - "shape":"DiskImageDescription", - "documentation":"The image.
", - "locationName":"image" - }, - "Volume":{ - "shape":"DiskImageVolumeDescription", - "documentation":"The volume.
", - "locationName":"volume" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the import of this particular disk image.
", - "locationName":"status" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The status information or errors related to the disk image.
", - "locationName":"statusMessage" - }, - "Description":{ - "shape":"String", - "locationName":"description" - } - }, - "documentation":"Describes an import volume task.
" - }, - "ImportInstanceVolumeDetailSet":{ - "type":"list", - "member":{ - "shape":"ImportInstanceVolumeDetailItem", - "locationName":"item" - } - }, - "ImportKeyPairRequest":{ - "type":"structure", - "required":[ - "KeyName", - "PublicKeyMaterial" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "KeyName":{ - "shape":"String", - "documentation":"A unique name for the key pair.
", - "locationName":"keyName" - }, - "PublicKeyMaterial":{ - "shape":"Blob", - "documentation":"The public key. You must base64 encode the public key material before sending it to AWS.
", - "locationName":"publicKeyMaterial" - } - } - }, - "ImportKeyPairResult":{ - "type":"structure", - "members":{ - "KeyName":{ - "shape":"String", - "documentation":"The key pair name you provided.
", - "locationName":"keyName" - }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"The MD5 public key fingerprint as specified in section 4 of RFC 4716.
", - "locationName":"keyFingerprint" - } - } - }, - "ImportVolumeRequest":{ - "type":"structure", - "required":[ - "AvailabilityZone", - "Image", - "Volume" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the resulting Amazon EBS volume.
", - "locationName":"availabilityZone" - }, - "Image":{ - "shape":"DiskImageDetail", - "locationName":"image" - }, - "Description":{ - "shape":"String", - "documentation":"An optional description for the volume being imported.
", - "locationName":"description" - }, - "Volume":{ - "shape":"VolumeDetail", - "locationName":"volume" - } - } - }, - "ImportVolumeResult":{ - "type":"structure", - "members":{ - "ConversionTask":{ - "shape":"ConversionTask", - "locationName":"conversionTask" - } - } - }, - "ImportVolumeTaskDetails":{ - "type":"structure", - "required":[ - "BytesConverted", - "AvailabilityZone", - "Image", - "Volume" - ], - "members":{ - "BytesConverted":{ - "shape":"Long", - "documentation":"The number of bytes converted so far.
", - "locationName":"bytesConverted" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where the resulting volume will reside.
", - "locationName":"availabilityZone" - }, - "Description":{ - "shape":"String", - "documentation":"The description you provided when starting the import volume task.
", - "locationName":"description" - }, - "Image":{ - "shape":"DiskImageDescription", - "documentation":"The image.
", - "locationName":"image" - }, - "Volume":{ - "shape":"DiskImageVolumeDescription", - "documentation":"The volume.
", - "locationName":"volume" - } - }, - "documentation":"Describes an import volume task.
" - }, - "Instance":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI used to launch the instance.
", - "locationName":"imageId" - }, - "State":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
", - "locationName":"instanceState" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
The public DNS name assigned to the instance. This name is not available until the instance enters the running state.
The reason for the most recent state transition. This might be an empty string.
", - "locationName":"reason" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair, if this instance was launched with an associated key pair.
", - "locationName":"keyName" - }, - "AmiLaunchIndex":{ - "shape":"Integer", - "documentation":"The AMI launch index, which can be used to find this instance in the launch group.
", - "locationName":"amiLaunchIndex" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"The product codes attached to this instance.
", - "locationName":"productCodes" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "LaunchTime":{ - "shape":"DateTime", - "documentation":"The time the instance was launched.
", - "locationName":"launchTime" - }, - "Placement":{ - "shape":"Placement", - "documentation":"The location where the instance launched.
", - "locationName":"placement" - }, - "KernelId":{ - "shape":"String", - "documentation":"The kernel associated with this instance.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The RAM disk associated with this instance.
", - "locationName":"ramdiskId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The value is Windows for Windows instances; otherwise blank.
The monitoring information for the instance.
", - "locationName":"monitoring" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which the instance is running.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC in which the instance is running.
", - "locationName":"vpcId" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address assigned to the instance.
", - "locationName":"privateIpAddress" - }, - "PublicIpAddress":{ - "shape":"String", - "documentation":"The public IP address assigned to the instance.
", - "locationName":"ipAddress" - }, - "StateReason":{ - "shape":"StateReason", - "documentation":"The reason for the most recent state transition.
", - "locationName":"stateReason" - }, - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the image.
", - "locationName":"architecture" - }, - "RootDeviceType":{ - "shape":"DeviceType", - "documentation":"The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
", - "locationName":"rootDeviceType" - }, - "RootDeviceName":{ - "shape":"String", - "documentation":"The root device name (for example, /dev/sda1).
Any block device mapping entries for the instance.
", - "locationName":"blockDeviceMapping" - }, - "VirtualizationType":{ - "shape":"VirtualizationType", - "documentation":"The virtualization type of the instance.
", - "locationName":"virtualizationType" - }, - "InstanceLifecycle":{ - "shape":"InstanceLifecycleType", - "documentation":"Indicates whether this is a Spot Instance.
", - "locationName":"instanceLifecycle" - }, - "SpotInstanceRequestId":{ - "shape":"String", - "documentation":"The ID of the Spot Instance request.
", - "locationName":"spotInstanceRequestId" - }, - "ClientToken":{ - "shape":"String", - "documentation":"The idempotency token you provided when you launched the instance.
", - "locationName":"clientToken" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the instance.
", - "locationName":"tagSet" - }, - "SecurityGroups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups for the instance.
", - "locationName":"groupSet" - }, - "SourceDestCheck":{ - "shape":"Boolean", - "documentation":"Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
The hypervisor type of the instance.
", - "locationName":"hypervisor" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceList", - "documentation":"[EC2-VPC] One or more network interfaces for the instance.
", - "locationName":"networkInterfaceSet" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfile", - "documentation":"The IAM instance profile associated with the instance.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", - "locationName":"ebsOptimized" - }, - "SriovNetSupport":{ - "shape":"String", - "documentation":"Specifies whether enhanced networking is enabled.
", - "locationName":"sriovNetSupport" - } - }, - "documentation":"Describes an instance.
" - }, - "InstanceAttribute":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "InstanceType":{ - "shape":"AttributeValue", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "KernelId":{ - "shape":"AttributeValue", - "documentation":"The kernel ID.
", - "locationName":"kernel" - }, - "RamdiskId":{ - "shape":"AttributeValue", - "documentation":"The RAM disk ID.
", - "locationName":"ramdisk" - }, - "UserData":{ - "shape":"AttributeValue", - "documentation":"The Base64-encoded MIME user data.
", - "locationName":"userData" - }, - "DisableApiTermination":{ - "shape":"AttributeBooleanValue", - "documentation":"If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, - "RootDeviceName":{ - "shape":"AttributeValue", - "documentation":"The name of the root device (for example, /dev/sda1).
The block device mapping of the instance.
", - "locationName":"blockDeviceMapping" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"A list of product codes.
", - "locationName":"productCodes" - }, - "EbsOptimized":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the instance is optimized for EBS I/O.
", - "locationName":"ebsOptimized" - }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "locationName":"sriovNetSupport" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
The security groups associated with the instance.
", - "locationName":"groupSet" - } - }, - "documentation":"Describes an instance attribute.
" - }, - "InstanceAttributeName":{ - "type":"string", - "enum":[ - "instanceType", - "kernel", - "ramdisk", - "userData", - "disableApiTermination", - "instanceInitiatedShutdownBehavior", - "rootDeviceName", - "blockDeviceMapping", - "productCodes", - "sourceDestCheck", - "groupSet", - "ebsOptimized", - "sriovNetSupport" - ] - }, - "InstanceBlockDeviceMapping":{ - "type":"structure", - "members":{ - "DeviceName":{ - "shape":"String", - "documentation":"The device name exposed to the instance (for example,
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
", - "locationName":"ebs" - } - }, - "documentation":"Describes a block device mapping.
" - }, - "InstanceBlockDeviceMappingList":{ - "type":"list", - "member":{ - "shape":"InstanceBlockDeviceMapping", - "locationName":"item" - } - }, - "InstanceBlockDeviceMappingSpecification":{ - "type":"structure", - "members":{ - "DeviceName":{ - "shape":"String", - "documentation":"The device name exposed to the instance (for example,
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
", - "locationName":"ebs" - }, - "VirtualName":{ - "shape":"String", - "documentation":"The virtual device name.
", - "locationName":"virtualName" - }, - "NoDevice":{ - "shape":"String", - "documentation":"suppress the specified device included in the block device mapping.
", - "locationName":"noDevice" - } - }, - "documentation":"Describes a block device mapping entry.
" - }, - "InstanceBlockDeviceMappingSpecificationList":{ - "type":"list", - "member":{ - "shape":"InstanceBlockDeviceMappingSpecification", - "locationName":"item" - } - }, - "InstanceCount":{ - "type":"structure", - "members":{ - "State":{ - "shape":"ListingState", - "documentation":"The states of the listed Reserved Instances.
", - "locationName":"state" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"he number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
" - }, - "InstanceCountList":{ - "type":"list", - "member":{ - "shape":"InstanceCount", - "locationName":"item" - } - }, - "InstanceExportDetails":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the resource being exported.
", - "locationName":"instanceId" - }, - "TargetEnvironment":{ - "shape":"ExportEnvironment", - "documentation":"The target virtualization environment.
", - "locationName":"targetEnvironment" - } - }, - "documentation":"Describes an instance export task.
" - }, - "InstanceIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"InstanceId" - } - }, - "InstanceLifecycleType":{ - "type":"string", - "enum":["spot"] - }, - "InstanceList":{ - "type":"list", - "member":{ - "shape":"Instance", - "locationName":"item" - } - }, - "InstanceMonitoring":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Monitoring":{ - "shape":"Monitoring", - "documentation":"The monitoring information.
", - "locationName":"monitoring" - } - }, - "documentation":"Describes the monitoring information of the instance.
" - }, - "InstanceMonitoringList":{ - "type":"list", - "member":{ - "shape":"InstanceMonitoring", - "locationName":"item" - } - }, - "InstanceNetworkInterface":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "Description":{ - "shape":"String", - "documentation":"The description.
", - "locationName":"description" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The ID of the AWS account that created the network interface.
", - "locationName":"ownerId" - }, - "Status":{ - "shape":"NetworkInterfaceStatus", - "documentation":"The status of the network interface.
", - "locationName":"status" - }, - "MacAddress":{ - "shape":"String", - "documentation":"The MAC address.
", - "locationName":"macAddress" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The IP address of the network interface within the subnet.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "SourceDestCheck":{ - "shape":"Boolean", - "documentation":"Indicates whether to validate network traffic to or from this network interface.
", - "locationName":"sourceDestCheck" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups.
", - "locationName":"groupSet" - }, - "Attachment":{ - "shape":"InstanceNetworkInterfaceAttachment", - "documentation":"The network interface attachment.
", - "locationName":"attachment" - }, - "Association":{ - "shape":"InstanceNetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP associated with the network interface.
", - "locationName":"association" - }, - "PrivateIpAddresses":{ - "shape":"InstancePrivateIpAddressList", - "documentation":"The private IP addresses associated with the network interface.
", - "locationName":"privateIpAddressesSet" - } - }, - "documentation":"Describes a network interface.
" - }, - "InstanceNetworkInterfaceAssociation":{ - "type":"structure", - "members":{ - "PublicIp":{ - "shape":"String", - "documentation":"The public IP address or Elastic IP address bound to the network interface.
", - "locationName":"publicIp" - }, - "PublicDnsName":{ - "shape":"String", - "documentation":"The public DNS name.
", - "locationName":"publicDnsName" - }, - "IpOwnerId":{ - "shape":"String", - "documentation":"The ID of the owner of the Elastic IP address.
", - "locationName":"ipOwnerId" - } - }, - "documentation":"Describes association information for an Elastic IP address.
" - }, - "InstanceNetworkInterfaceAttachment":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The index of the device on the instance for the network interface attachment.
", - "locationName":"deviceIndex" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"The attachment state.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is deleted when the instance is terminated.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes a network interface attachment.
" - }, - "InstanceNetworkInterfaceList":{ - "type":"list", - "member":{ - "shape":"InstanceNetworkInterface", - "locationName":"item" - } - }, - "InstanceNetworkInterfaceSpecification":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
", - "locationName":"deviceIndex" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
", - "locationName":"subnetId" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the network interface. Applies only if creating a network interface when launching an instance.
", - "locationName":"description" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address of the network interface. Applies only if creating a network interface when launching an instance.
", - "locationName":"privateIpAddress" - }, - "Groups":{ - "shape":"SecurityGroupIdStringList", - "documentation":"The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
", - "locationName":"SecurityGroupId" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.
", - "locationName":"privateIpAddressesSet", - "queryName":"PrivateIpAddresses" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.
", - "locationName":"secondaryPrivateIpAddressCount" - }, - "AssociatePublicIpAddress":{ - "shape":"Boolean", - "documentation":"Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If luanching into a default subnet, the default value is true.
Describes a network interface.
" - }, - "InstanceNetworkInterfaceSpecificationList":{ - "type":"list", - "member":{ - "shape":"InstanceNetworkInterfaceSpecification", - "locationName":"item" - } - }, - "InstancePrivateIpAddress":{ - "type":"structure", - "members":{ - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address of the network interface.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "Primary":{ - "shape":"Boolean", - "documentation":"Indicates whether this IP address is the primary private IP address of the network interface.
", - "locationName":"primary" - }, - "Association":{ - "shape":"InstanceNetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP address for the network interface.
", - "locationName":"association" - } - }, - "documentation":"Describes a private IP address.
" - }, - "InstancePrivateIpAddressList":{ - "type":"list", - "member":{ - "shape":"InstancePrivateIpAddress", - "locationName":"item" - } - }, - "InstanceState":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"Integer", - "documentation":"The low byte represents the state. The high byte is an opaque internal value and should be ignored.
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
", - "locationName":"name" - } - }, - "documentation":"Describes the current state of the instance.
" - }, - "InstanceStateChange":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "CurrentState":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
", - "locationName":"currentState" - }, - "PreviousState":{ - "shape":"InstanceState", - "documentation":"The previous state of the instance.
", - "locationName":"previousState" - } - }, - "documentation":"Describes an instance state change.
" - }, - "InstanceStateChangeList":{ - "type":"list", - "member":{ - "shape":"InstanceStateChange", - "locationName":"item" - } - }, - "InstanceStateName":{ - "type":"string", - "enum":[ - "pending", - "running", - "shutting-down", - "terminated", - "stopping", - "stopped" - ] - }, - "InstanceStatus":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the instance.
", - "locationName":"availabilityZone" - }, - "Events":{ - "shape":"InstanceStatusEventList", - "documentation":"Extra information regarding events associated with the instance.
", - "locationName":"eventsSet" - }, - "InstanceState":{ - "shape":"InstanceState", - "documentation":"The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
", - "locationName":"systemStatus" - }, - "InstanceStatus":{ - "shape":"InstanceStatusSummary", - "documentation":"Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
", - "locationName":"instanceStatus" - } - }, - "documentation":"Describes the status of an instance.
" - }, - "InstanceStatusDetails":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"StatusName", - "documentation":"The type of instance status.
", - "locationName":"name" - }, - "Status":{ - "shape":"StatusType", - "documentation":"The status.
", - "locationName":"status" - }, - "ImpairedSince":{ - "shape":"DateTime", - "documentation":"The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
", - "locationName":"impairedSince" - } - }, - "documentation":"Describes the instance status.
" - }, - "InstanceStatusDetailsList":{ - "type":"list", - "member":{ - "shape":"InstanceStatusDetails", - "locationName":"item" - } - }, - "InstanceStatusEvent":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"EventCode", - "documentation":"The associated code of the event.
", - "locationName":"code" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the event.
", - "locationName":"description" - }, - "NotBefore":{ - "shape":"DateTime", - "documentation":"The earliest scheduled start time for the event.
", - "locationName":"notBefore" - }, - "NotAfter":{ - "shape":"DateTime", - "documentation":"The latest scheduled end time for the event.
", - "locationName":"notAfter" - } - }, - "documentation":"Describes an instance event.
" - }, - "InstanceStatusEventList":{ - "type":"list", - "member":{ - "shape":"InstanceStatusEvent", - "locationName":"item" - } - }, - "InstanceStatusList":{ - "type":"list", - "member":{ - "shape":"InstanceStatus", - "locationName":"item" - } - }, - "InstanceStatusSummary":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"SummaryStatus", - "documentation":"The status.
", - "locationName":"status" - }, - "Details":{ - "shape":"InstanceStatusDetailsList", - "documentation":"The system instance health or application instance health.
", - "locationName":"details" - } - }, - "documentation":"Describes the status of an instance.
" - }, - "InstanceType":{ - "type":"string", - "enum":[ - "t1.micro", - "m1.small", - "m1.medium", - "m1.large", - "m1.xlarge", - "m3.medium", - "m3.large", - "m3.xlarge", - "m3.2xlarge", - "t2.micro", - "t2.small", - "t2.medium", - "m2.xlarge", - "m2.2xlarge", - "m2.4xlarge", - "cr1.8xlarge", - "i2.xlarge", - "i2.2xlarge", - "i2.4xlarge", - "i2.8xlarge", - "hi1.4xlarge", - "hs1.8xlarge", - "c1.medium", - "c1.xlarge", - "c3.large", - "c3.xlarge", - "c3.2xlarge", - "c3.4xlarge", - "c3.8xlarge", - "c4.large", - "c4.xlarge", - "c4.2xlarge", - "c4.4xlarge", - "c4.8xlarge", - "cc1.4xlarge", - "cc2.8xlarge", - "g2.2xlarge", - "cg1.4xlarge", - "r3.large", - "r3.xlarge", - "r3.2xlarge", - "r3.4xlarge", - "r3.8xlarge" - ] - }, - "InstanceTypeList":{ - "type":"list", - "member":{"shape":"InstanceType"} - }, - "Integer":{"type":"integer"}, - "InternetGateway":{ - "type":"structure", - "members":{ - "InternetGatewayId":{ - "shape":"String", - "documentation":"The ID of the Internet gateway.
", - "locationName":"internetGatewayId" - }, - "Attachments":{ - "shape":"InternetGatewayAttachmentList", - "documentation":"Any VPCs attached to the Internet gateway.
", - "locationName":"attachmentSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the Internet gateway.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes an Internet gateway.
" - }, - "InternetGatewayAttachment":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "State":{ - "shape":"AttachmentStatus", - "documentation":"The current state of the attachment.
", - "locationName":"state" - } - }, - "documentation":"Describes the attachment of a VPC to an Internet gateway.
" - }, - "InternetGatewayAttachmentList":{ - "type":"list", - "member":{ - "shape":"InternetGatewayAttachment", - "locationName":"item" - } - }, - "InternetGatewayList":{ - "type":"list", - "member":{ - "shape":"InternetGateway", - "locationName":"item" - } - }, - "IpPermission":{ - "type":"structure", - "members":{ - "IpProtocol":{ - "shape":"String", - "documentation":"The protocol.
When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
One or more security group and AWS account ID pairs.
", - "locationName":"groups" - }, - "IpRanges":{ - "shape":"IpRangeList", - "documentation":"One or more IP ranges.
", - "locationName":"ipRanges" - } - }, - "documentation":"Describes a security group rule.
" - }, - "IpPermissionList":{ - "type":"list", - "member":{ - "shape":"IpPermission", - "locationName":"item" - } - }, - "IpRange":{ - "type":"structure", - "members":{ - "CidrIp":{ - "shape":"String", - "documentation":"The CIDR range. You can either specify a CIDR range or a source security group, not both.
", - "locationName":"cidrIp" - } - }, - "documentation":"Describes an IP range.
" - }, - "IpRangeList":{ - "type":"list", - "member":{ - "shape":"IpRange", - "locationName":"item" - } - }, - "KeyNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"KeyName" - } - }, - "KeyPair":{ - "type":"structure", - "members":{ - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"The SHA-1 digest of the DER encoded private key.
", - "locationName":"keyFingerprint" - }, - "KeyMaterial":{ - "shape":"String", - "documentation":"An unencrypted PEM encoded RSA private key.
", - "locationName":"keyMaterial" - } - }, - "documentation":"Describes a key pair.
" - }, - "KeyPairInfo":{ - "type":"structure", - "members":{ - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
", - "locationName":"keyFingerprint" - } - }, - "documentation":"Describes a key pair.
" - }, - "KeyPairList":{ - "type":"list", - "member":{ - "shape":"KeyPairInfo", - "locationName":"item" - } - }, - "LaunchPermission":{ - "type":"structure", - "members":{ - "UserId":{ - "shape":"String", - "documentation":"The AWS account ID.
", - "locationName":"userId" - }, - "Group":{ - "shape":"PermissionGroup", - "documentation":"The name of the group.
", - "locationName":"group" - } - }, - "documentation":"Describes a launch permission.
" - }, - "LaunchPermissionList":{ - "type":"list", - "member":{ - "shape":"LaunchPermission", - "locationName":"item" - } - }, - "LaunchPermissionModifications":{ - "type":"structure", - "members":{ - "Add":{ - "shape":"LaunchPermissionList", - "documentation":"The AWS account ID to add to the list of launch permissions for the AMI.
" - }, - "Remove":{ - "shape":"LaunchPermissionList", - "documentation":"The AWS account ID to remove from the list of launch permissions for the AMI.
" - } - }, - "documentation":"Describes a launch permission modification.
" - }, - "LaunchSpecification":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "SecurityGroups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.
", - "locationName":"groupSet" - }, - "UserData":{ - "shape":"String", - "documentation":"The Base64-encoded MIME user data to make available to the instances.
", - "locationName":"userData" - }, - "AddressingType":{ - "shape":"String", - "documentation":"Deprecated.
", - "locationName":"addressingType" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
Default: m1.small
The placement information for the instance.
", - "locationName":"placement" - }, - "KernelId":{ - "shape":"String", - "documentation":"The ID of the kernel.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The ID of the RAM disk.
", - "locationName":"ramdiskId" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"One or more block device mapping entries.
", - "locationName":"blockDeviceMapping" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which to launch the instance.
", - "locationName":"subnetId" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceSpecificationList", - "documentation":"One or more network interfaces.
", - "locationName":"networkInterfaceSet" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfileSpecification", - "documentation":"The IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Describes the launch specification for an instance.
" - }, - "ListingState":{ - "type":"string", - "enum":[ - "available", - "sold", - "cancelled", - "pending" - ] - }, - "ListingStatus":{ - "type":"string", - "enum":[ - "active", - "pending", - "cancelled", - "closed" - ] - }, - "Long":{"type":"long"}, - "ModifyImageAttributeRequest":{ - "type":"structure", - "required":["ImageId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - }, - "Attribute":{ - "shape":"String", - "documentation":"The name of the attribute to modify.
" - }, - "OperationType":{ - "shape":"String", - "documentation":"The operation type.
" - }, - "UserIds":{ - "shape":"UserIdStringList", - "documentation":"One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
One or more user groups. This is only valid when modifying the launchPermission attribute.
One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
The value of the attribute being modified. This is only valid when modifying the description attribute.
A description for the AMI.
" - } - } - }, - "ModifyInstanceAttributeRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The name of the attribute.
", - "locationName":"attribute" - }, - "Value":{ - "shape":"String", - "documentation":"A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide for Linux.
", - "locationName":"blockDeviceMapping" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", - "locationName":"kernel" - }, - "Ramdisk":{ - "shape":"AttributeValue", - "documentation":"Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", - "locationName":"ramdisk" - }, - "UserData":{ - "shape":"BlobAttributeValue", - "documentation":"Changes the instance's user data to the specified value.
", - "locationName":"userData" - }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"AttributeValue", - "documentation":"Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, - "Groups":{ - "shape":"GroupIdStringList", - "documentation":"[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
For example, if you want the instance to be in sg-1a1a1a1a and sg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and GroupId.2=sg-9b9b9b9b.
Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", - "locationName":"ebsOptimized" - }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "documentation":"Set to simple to enable enhanced networking for the instance.
There is no way to disable enhanced networking at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", - "locationName":"sriovNetSupport" - } - } - }, - "ModifyNetworkInterfaceAttributeRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "Description":{ - "shape":"AttributeValue", - "documentation":"A description for the network interface.
", - "locationName":"description" - }, - "SourceDestCheck":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", - "locationName":"SecurityGroupId" - }, - "Attachment":{ - "shape":"NetworkInterfaceAttachmentChanges", - "documentation":"Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
", - "locationName":"attachment" - } - } - }, - "ModifyReservedInstancesRequest":{ - "type":"structure", - "required":[ - "ReservedInstancesIds", - "TargetConfigurations" - ], - "members":{ - "ClientToken":{ - "shape":"String", - "documentation":"A unique, case-sensitive token you provide to ensure idempotency of your modification request.
", - "locationName":"clientToken" - }, - "ReservedInstancesIds":{ - "shape":"ReservedInstancesIdStringList", - "documentation":"The IDs of the Reserved Instances to modify.
", - "locationName":"ReservedInstancesId" - }, - "TargetConfigurations":{ - "shape":"ReservedInstancesConfigurationList", - "documentation":"The configuration settings for the Reserved Instances to modify.
", - "locationName":"ReservedInstancesConfigurationSetItemType" - } - } - }, - "ModifyReservedInstancesResult":{ - "type":"structure", - "members":{ - "ReservedInstancesModificationId":{ - "shape":"String", - "documentation":"The ID for the modification.
", - "locationName":"reservedInstancesModificationId" - } - } - }, - "ModifySnapshotAttributeRequest":{ - "type":"structure", - "required":["SnapshotId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot.
" - }, - "Attribute":{ - "shape":"SnapshotAttributeName", - "documentation":"The snapshot attribute to modify.
" - }, - "OperationType":{ - "shape":"String", - "documentation":"The type of operation to perform to the attribute.
" - }, - "UserIds":{ - "shape":"UserIdStringList", - "documentation":"The account ID to modify for the snapshot.
", - "locationName":"UserId" - }, - "GroupNames":{ - "shape":"GroupNameStringList", - "documentation":"The group to modify for the snapshot.
", - "locationName":"UserGroup" - }, - "CreateVolumePermission":{ - "shape":"CreateVolumePermissionModifications", - "documentation":"A JSON representation of the snapshot attribute modification.
" - } - } - }, - "ModifySubnetAttributeRequest":{ - "type":"structure", - "required":["SubnetId"], - "members":{ - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "MapPublicIpOnLaunch":{"shape":"AttributeBooleanValue"} - } - }, - "ModifyVolumeAttributeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
" - }, - "AutoEnableIO":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the volume should be auto-enabled for I/O operations.
" - } - } - }, - "ModifyVpcAttributeRequest":{ - "type":"structure", - "required":["VpcId"], - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "EnableDnsSupport":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
" - }, - "EnableDnsHostnames":{ - "shape":"AttributeBooleanValue", - "documentation":"Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You can only enable DNS hostnames if you also enable DNS support.
" - } - } - }, - "MonitorInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "MonitorInstancesResult":{ - "type":"structure", - "members":{ - "InstanceMonitorings":{ - "shape":"InstanceMonitoringList", - "documentation":"Monitoring information for one or more instances.
", - "locationName":"instancesSet" - } - } - }, - "Monitoring":{ - "type":"structure", - "members":{ - "State":{ - "shape":"MonitoringState", - "documentation":"Indicates whether monitoring is enabled for the instance.
", - "locationName":"state" - } - }, - "documentation":"Describes the monitoring for the instance.
" - }, - "MonitoringState":{ - "type":"string", - "enum":[ - "disabled", - "enabled", - "pending" - ] - }, - "NetworkAcl":{ - "type":"structure", - "members":{ - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC for the network ACL.
", - "locationName":"vpcId" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the default network ACL for the VPC.
", - "locationName":"default" - }, - "Entries":{ - "shape":"NetworkAclEntryList", - "documentation":"One or more entries (rules) in the network ACL.
", - "locationName":"entrySet" - }, - "Associations":{ - "shape":"NetworkAclAssociationList", - "documentation":"Any associations between the network ACL and one or more subnets
", - "locationName":"associationSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the network ACL.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a network ACL.
" - }, - "NetworkAclAssociation":{ - "type":"structure", - "members":{ - "NetworkAclAssociationId":{ - "shape":"String", - "documentation":"The ID of the association between a network ACL and a subnet.
", - "locationName":"networkAclAssociationId" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the network ACL.
", - "locationName":"networkAclId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - } - }, - "documentation":"Describes an association between a network ACL and a subnet.
" - }, - "NetworkAclAssociationList":{ - "type":"list", - "member":{ - "shape":"NetworkAclAssociation", - "locationName":"item" - } - }, - "NetworkAclEntry":{ - "type":"structure", - "members":{ - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number for the entry. ACL entries are processed in ascending order by rule number.
", - "locationName":"ruleNumber" - }, - "Protocol":{ - "shape":"String", - "documentation":"The protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
", - "locationName":"ruleAction" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
", - "locationName":"egress" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range to allow or deny, in CIDR notation.
", - "locationName":"cidrBlock" - }, - "IcmpTypeCode":{ - "shape":"IcmpTypeCode", - "documentation":"ICMP protocol: The ICMP type and code.
", - "locationName":"icmpTypeCode" - }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to.
", - "locationName":"portRange" - } - }, - "documentation":"Describes an entry in a network ACL.
" - }, - "NetworkAclEntryList":{ - "type":"list", - "member":{ - "shape":"NetworkAclEntry", - "locationName":"item" - } - }, - "NetworkAclList":{ - "type":"list", - "member":{ - "shape":"NetworkAcl", - "locationName":"item" - } - }, - "NetworkInterface":{ - "type":"structure", - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone.
", - "locationName":"availabilityZone" - }, - "Description":{ - "shape":"String", - "documentation":"A description.
", - "locationName":"description" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the network interface.
", - "locationName":"ownerId" - }, - "RequesterId":{ - "shape":"String", - "documentation":"The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
", - "locationName":"requesterId" - }, - "RequesterManaged":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is being managed by AWS.
", - "locationName":"requesterManaged" - }, - "Status":{ - "shape":"NetworkInterfaceStatus", - "documentation":"The status of the network interface.
", - "locationName":"status" - }, - "MacAddress":{ - "shape":"String", - "documentation":"The MAC address.
", - "locationName":"macAddress" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The IP address of the network interface within the subnet.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "SourceDestCheck":{ - "shape":"Boolean", - "documentation":"Indicates whether traffic to or from the instance is validated.
", - "locationName":"sourceDestCheck" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"Any security groups for the network interface.
", - "locationName":"groupSet" - }, - "Attachment":{ - "shape":"NetworkInterfaceAttachment", - "documentation":"The network interface attachment.
", - "locationName":"attachment" - }, - "Association":{ - "shape":"NetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP associated with the network interface.
", - "locationName":"association" - }, - "TagSet":{ - "shape":"TagList", - "documentation":"Any tags assigned to the network interface.
", - "locationName":"tagSet" - }, - "PrivateIpAddresses":{ - "shape":"NetworkInterfacePrivateIpAddressList", - "documentation":"The private IP addresses associated with the network interface.
", - "locationName":"privateIpAddressesSet" - } - }, - "documentation":"Describes a network interface.
" - }, - "NetworkInterfaceAssociation":{ - "type":"structure", - "members":{ - "PublicIp":{ - "shape":"String", - "documentation":"The address of the Elastic IP address bound to the network interface.
", - "locationName":"publicIp" - }, - "PublicDnsName":{ - "shape":"String", - "documentation":"The public DNS name.
", - "locationName":"publicDnsName" - }, - "IpOwnerId":{ - "shape":"String", - "documentation":"The ID of the Elastic IP address owner.
", - "locationName":"ipOwnerId" - }, - "AllocationId":{ - "shape":"String", - "documentation":"The allocation ID.
", - "locationName":"allocationId" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The association ID.
", - "locationName":"associationId" - } - }, - "documentation":"Describes association information for an Elastic IP address.
" - }, - "NetworkInterfaceAttachment":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "InstanceOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the instance.
", - "locationName":"instanceOwnerId" - }, - "DeviceIndex":{ - "shape":"Integer", - "documentation":"The device index of the network interface attachment on the instance.
", - "locationName":"deviceIndex" - }, - "Status":{ - "shape":"AttachmentStatus", - "documentation":"The attachment state.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The timestamp indicating when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is deleted when the instance is terminated.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes a network interface attachment.
" - }, - "NetworkInterfaceAttachmentChanges":{ - "type":"structure", - "members":{ - "AttachmentId":{ - "shape":"String", - "documentation":"The ID of the network interface attachment.
", - "locationName":"attachmentId" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the network interface is deleted when the instance is terminated.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes an attachment change.
" - }, - "NetworkInterfaceAttribute":{ - "type":"string", - "enum":[ - "description", - "groupSet", - "sourceDestCheck", - "attachment" - ] - }, - "NetworkInterfaceIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"item" - } - }, - "NetworkInterfaceList":{ - "type":"list", - "member":{ - "shape":"NetworkInterface", - "locationName":"item" - } - }, - "NetworkInterfacePrivateIpAddress":{ - "type":"structure", - "members":{ - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address.
", - "locationName":"privateIpAddress" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name.
", - "locationName":"privateDnsName" - }, - "Primary":{ - "shape":"Boolean", - "documentation":"Indicates whether this IP address is the primary private IP address of the network interface.
", - "locationName":"primary" - }, - "Association":{ - "shape":"NetworkInterfaceAssociation", - "documentation":"The association information for an Elastic IP address associated with the network interface.
", - "locationName":"association" - } - }, - "documentation":"Describes the private IP address of a network interface.
" - }, - "NetworkInterfacePrivateIpAddressList":{ - "type":"list", - "member":{ - "shape":"NetworkInterfacePrivateIpAddress", - "locationName":"item" - } - }, - "NetworkInterfaceStatus":{ - "type":"string", - "enum":[ - "available", - "attaching", - "in-use", - "detaching" - ] - }, - "OfferingTypeValues":{ - "type":"string", - "enum":[ - "Heavy Utilization", - "Medium Utilization", - "Light Utilization" - ] - }, - "OwnerStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"Owner" - } - }, - "PermissionGroup":{ - "type":"string", - "enum":["all"] - }, - "Placement":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the instance.
", - "locationName":"availabilityZone" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group the instance is in (for cluster compute instances).
", - "locationName":"groupName" - }, - "Tenancy":{ - "shape":"Tenancy", - "documentation":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
Describes the placement for the instance.
" - }, - "PlacementGroup":{ - "type":"structure", - "members":{ - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group.
", - "locationName":"groupName" - }, - "Strategy":{ - "shape":"PlacementStrategy", - "documentation":"The placement strategy.
", - "locationName":"strategy" - }, - "State":{ - "shape":"PlacementGroupState", - "documentation":"The state of the placement group.
", - "locationName":"state" - } - }, - "documentation":"Describes a placement group.
" - }, - "PlacementGroupList":{ - "type":"list", - "member":{ - "shape":"PlacementGroup", - "locationName":"item" - } - }, - "PlacementGroupState":{ - "type":"string", - "enum":[ - "pending", - "available", - "deleting", - "deleted" - ] - }, - "PlacementGroupStringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PlacementStrategy":{ - "type":"string", - "enum":["cluster"] - }, - "PlatformValues":{ - "type":"string", - "enum":["Windows"] - }, - "PortRange":{ - "type":"structure", - "members":{ - "From":{ - "shape":"Integer", - "documentation":"The first port in the range.
", - "locationName":"from" - }, - "To":{ - "shape":"Integer", - "documentation":"The last port in the range.
", - "locationName":"to" - } - }, - "documentation":"Describes a range of ports.
" - }, - "PriceSchedule":{ - "type":"structure", - "members":{ - "Term":{ - "shape":"Long", - "documentation":"The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", - "locationName":"term" - }, - "Price":{ - "shape":"Double", - "documentation":"The fixed price for the term.
", - "locationName":"price" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
", - "locationName":"active" - } - }, - "documentation":"Describes the price for a Reserved Instance.
" - }, - "PriceScheduleList":{ - "type":"list", - "member":{ - "shape":"PriceSchedule", - "locationName":"item" - } - }, - "PriceScheduleSpecification":{ - "type":"structure", - "members":{ - "Term":{ - "shape":"Long", - "documentation":"The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", - "locationName":"term" - }, - "Price":{ - "shape":"Double", - "documentation":"The fixed price for the term.
", - "locationName":"price" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
Describes the price for a Reserved Instance.
" - }, - "PriceScheduleSpecificationList":{ - "type":"list", - "member":{ - "shape":"PriceScheduleSpecification", - "locationName":"item" - } - }, - "PricingDetail":{ - "type":"structure", - "members":{ - "Price":{ - "shape":"Double", - "documentation":"The price per instance.
", - "locationName":"price" - }, - "Count":{ - "shape":"Integer", - "documentation":"The number of instances available for the price.
", - "locationName":"count" - } - }, - "documentation":"Describes a Reserved Instance offering.
" - }, - "PricingDetailsList":{ - "type":"list", - "member":{ - "shape":"PricingDetail", - "locationName":"item" - } - }, - "PrivateIpAddressSpecification":{ - "type":"structure", - "required":["PrivateIpAddress"], - "members":{ - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP addresses.
", - "locationName":"privateIpAddress" - }, - "Primary":{ - "shape":"Boolean", - "documentation":"Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
", - "locationName":"primary" - } - }, - "documentation":"Describes a secondary private IP address for a network interface.
" - }, - "PrivateIpAddressSpecificationList":{ - "type":"list", - "member":{ - "shape":"PrivateIpAddressSpecification", - "locationName":"item" - } - }, - "PrivateIpAddressStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"PrivateIpAddress" - } - }, - "ProductCode":{ - "type":"structure", - "members":{ - "ProductCodeId":{ - "shape":"String", - "documentation":"The product code.
", - "locationName":"productCode" - }, - "ProductCodeType":{ - "shape":"ProductCodeValues", - "documentation":"The type of product code.
", - "locationName":"type" - } - }, - "documentation":"Describes a product code.
" - }, - "ProductCodeList":{ - "type":"list", - "member":{ - "shape":"ProductCode", - "locationName":"item" - } - }, - "ProductCodeStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ProductCode" - } - }, - "ProductCodeValues":{ - "type":"string", - "enum":[ - "devpay", - "marketplace" - ] - }, - "ProductDescriptionList":{ - "type":"list", - "member":{"shape":"String"} - }, - "PropagatingVgw":{ - "type":"structure", - "members":{ - "GatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway (VGW).
", - "locationName":"gatewayId" - } - }, - "documentation":"Describes a virtual private gateway propagating route.
" - }, - "PropagatingVgwList":{ - "type":"list", - "member":{ - "shape":"PropagatingVgw", - "locationName":"item" - } - }, - "PublicIpStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"PublicIp" - } - }, - "PurchaseReservedInstancesOfferingRequest":{ - "type":"structure", - "required":[ - "ReservedInstancesOfferingId", - "InstanceCount" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ReservedInstancesOfferingId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance offering to purchase.
" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of Reserved Instances to purchase.
" - }, - "LimitPrice":{ - "shape":"ReservedInstanceLimitPrice", - "documentation":"Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
", - "locationName":"limitPrice" - } - } - }, - "PurchaseReservedInstancesOfferingResult":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The IDs of the purchased Reserved Instances.
", - "locationName":"reservedInstancesId" - } - } - }, - "RIProductDescription":{ - "type":"string", - "enum":[ - "Linux/UNIX", - "Linux/UNIX (Amazon VPC)", - "Windows", - "Windows (Amazon VPC)" - ] - }, - "ReasonCodesList":{ - "type":"list", - "member":{ - "shape":"ReportInstanceReasonCodes", - "locationName":"item" - } - }, - "RebootInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "RecurringCharge":{ - "type":"structure", - "members":{ - "Frequency":{ - "shape":"RecurringChargeFrequency", - "documentation":"The frequency of the recurring charge.
", - "locationName":"frequency" - }, - "Amount":{ - "shape":"Double", - "documentation":"The amount of the recurring charge.
", - "locationName":"amount" - } - }, - "documentation":"Describes a recurring charge.
" - }, - "RecurringChargeFrequency":{ - "type":"string", - "enum":["Hourly"] - }, - "RecurringChargesList":{ - "type":"list", - "member":{ - "shape":"RecurringCharge", - "locationName":"item" - } - }, - "Region":{ - "type":"structure", - "members":{ - "RegionName":{ - "shape":"String", - "documentation":"The name of the region.
", - "locationName":"regionName" - }, - "Endpoint":{ - "shape":"String", - "documentation":"The region service endpoint.
", - "locationName":"regionEndpoint" - } - }, - "documentation":"Describes a region.
" - }, - "RegionList":{ - "type":"list", - "member":{ - "shape":"Region", - "locationName":"item" - } - }, - "RegionNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"RegionName" - } - }, - "RegisterImageRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageLocation":{ - "shape":"String", - "documentation":"The full path to your AMI manifest in Amazon S3 storage.
" - }, - "Name":{ - "shape":"String", - "documentation":"A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", - "locationName":"name" - }, - "Description":{ - "shape":"String", - "documentation":"A description for your AMI.
", - "locationName":"description" - }, - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The ID of the kernel.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The ID of the RAM disk.
", - "locationName":"ramdiskId" - }, - "RootDeviceName":{ - "shape":"String", - "documentation":"The name of the root device (for example, /dev/sda1, or xvda).
One or more block device mapping entries.
", - "locationName":"BlockDeviceMapping" - }, - "VirtualizationType":{ - "shape":"String", - "documentation":"The type of virtualization.
Default: paravirtual
Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.
There is no way to disable enhanced networking at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", - "locationName":"sriovNetSupport" - } - } - }, - "RegisterImageResult":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the newly registered AMI.
", - "locationName":"imageId" - } - } - }, - "RejectVpcPeeringConnectionRequest":{ - "type":"structure", - "required":["VpcPeeringConnectionId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "RejectVpcPeeringConnectionResult":{ - "type":"structure", - "members":{ - "Return":{ - "shape":"Boolean", - "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" - }, - "AllocationId":{ - "shape":"String", - "documentation":"[EC2-VPC] The allocation ID. Required for EC2-VPC.
" - } - } - }, - "ReplaceNetworkAclAssociationRequest":{ - "type":"structure", - "required":[ - "AssociationId", - "NetworkAclId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The ID of the current association between the original network ACL and the subnet.
", - "locationName":"associationId" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the new network ACL to associate with the subnet.
", - "locationName":"networkAclId" - } - } - }, - "ReplaceNetworkAclAssociationResult":{ - "type":"structure", - "members":{ - "NewAssociationId":{ - "shape":"String", - "documentation":"The ID of the new association.
", - "locationName":"newAssociationId" - } - } - }, - "ReplaceNetworkAclEntryRequest":{ - "type":"structure", - "required":[ - "NetworkAclId", - "RuleNumber", - "Protocol", - "RuleAction", - "Egress", - "CidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkAclId":{ - "shape":"String", - "documentation":"The ID of the ACL.
", - "locationName":"networkAclId" - }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number of the entry to replace.
", - "locationName":"ruleNumber" - }, - "Protocol":{ - "shape":"String", - "documentation":"The IP protocol. You can specify all or -1 to mean all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
", - "locationName":"ruleAction" - }, - "Egress":{ - "shape":"Boolean", - "documentation":"Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
", - "locationName":"egress" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The network range to allow or deny, in CIDR notation.
", - "locationName":"cidrBlock" - }, - "IcmpTypeCode":{ - "shape":"IcmpTypeCode", - "documentation":"ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.
", - "locationName":"Icmp" - }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.
", - "locationName":"portRange" - } - } - }, - "ReplaceRouteRequest":{ - "type":"structure", - "required":[ - "RouteTableId", - "DestinationCidrBlock" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.
", - "locationName":"destinationCidrBlock" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of an Internet gateway or virtual private gateway.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of a NAT instance in your VPC.
", - "locationName":"instanceId" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of a network interface.
", - "locationName":"networkInterfaceId" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of a VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - } - }, - "ReplaceRouteTableAssociationRequest":{ - "type":"structure", - "required":[ - "AssociationId", - "RouteTableId" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "AssociationId":{ - "shape":"String", - "documentation":"The association ID.
", - "locationName":"associationId" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the new route table to associate with the subnet.
", - "locationName":"routeTableId" - } - } - }, - "ReplaceRouteTableAssociationResult":{ - "type":"structure", - "members":{ - "NewAssociationId":{ - "shape":"String", - "documentation":"The ID of the new association.
", - "locationName":"newAssociationId" - } - } - }, - "ReportInstanceReasonCodes":{ - "type":"string", - "enum":[ - "instance-stuck-in-state", - "unresponsive", - "not-accepting-credentials", - "password-not-available", - "performance-network", - "performance-instance-store", - "performance-ebs-volume", - "performance-other", - "other" - ] - }, - "ReportInstanceStatusRequest":{ - "type":"structure", - "required":[ - "Instances", - "Status", - "ReasonCodes" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "Instances":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instances.
", - "locationName":"instanceId" - }, - "Status":{ - "shape":"ReportStatusType", - "documentation":"The status of all instances listed.
", - "locationName":"status" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time at which the reported instance health state began.
", - "locationName":"startTime" - }, - "EndTime":{ - "shape":"DateTime", - "documentation":"The time at which the reported instance health state ended.
", - "locationName":"endTime" - }, - "ReasonCodes":{ - "shape":"ReasonCodesList", - "documentation":"One or more reason codes that describes the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems which I believe are network related.
performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Descriptive text about the health state of your instance.
", - "locationName":"description" - } - } - }, - "ReportStatusType":{ - "type":"string", - "enum":[ - "ok", - "impaired" - ] - }, - "RequestSpotInstancesRequest":{ - "type":"structure", - "required":["SpotPrice"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "SpotPrice":{ - "shape":"String", - "documentation":"The maximum hourly price for any Spot Instance launched to fulfill the request.
", - "locationName":"spotPrice" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The maximum number of Spot Instances to launch.
Default: 1
", - "locationName":"instanceCount" - }, - "Type":{ - "shape":"SpotInstanceType", - "documentation":"The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
Default: The request is effective indefinitely.
", - "locationName":"validFrom" - }, - "ValidUntil":{ - "shape":"DateTime", - "documentation":"The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
Default: The request is effective indefinitely.
", - "locationName":"validUntil" - }, - "LaunchGroup":{ - "shape":"String", - "documentation":"The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
", - "locationName":"launchGroup" - }, - "AvailabilityZoneGroup":{ - "shape":"String", - "documentation":"The user-specified name for a logical grouping of bids.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
", - "locationName":"availabilityZoneGroup" - }, - "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} - } - }, - "RequestSpotInstancesResult":{ - "type":"structure", - "members":{ - "SpotInstanceRequests":{ - "shape":"SpotInstanceRequestList", - "documentation":"One or more Spot Instance requests.
", - "locationName":"spotInstanceRequestSet" - } - } - }, - "Reservation":{ - "type":"structure", - "members":{ - "ReservationId":{ - "shape":"String", - "documentation":"The ID of the reservation.
", - "locationName":"reservationId" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The ID of the AWS account that owns the reservation.
", - "locationName":"ownerId" - }, - "RequesterId":{ - "shape":"String", - "documentation":"The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
", - "locationName":"requesterId" - }, - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"One or more security groups.
", - "locationName":"groupSet" - }, - "Instances":{ - "shape":"InstanceList", - "documentation":"One or more instances.
", - "locationName":"instancesSet" - } - }, - "documentation":"Describes a reservation.
" - }, - "ReservationList":{ - "type":"list", - "member":{ - "shape":"Reservation", - "locationName":"item" - } - }, - "ReservedInstanceLimitPrice":{ - "type":"structure", - "members":{ - "Amount":{ - "shape":"Double", - "documentation":"Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
", - "locationName":"amount" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
Describes the limit price of a Reserved Instance offering.
" - }, - "ReservedInstanceState":{ - "type":"string", - "enum":[ - "payment-pending", - "active", - "payment-failed", - "retired" - ] - }, - "ReservedInstances":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used.
", - "locationName":"instanceType" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
", - "locationName":"availabilityZone" - }, - "Start":{ - "shape":"DateTime", - "documentation":"The date and time the Reserved Instance started.
", - "locationName":"start" - }, - "End":{ - "shape":"DateTime", - "documentation":"The time when the Reserved Instance expires.
", - "locationName":"end" - }, - "Duration":{ - "shape":"Long", - "documentation":"The duration of the Reserved Instance, in seconds.
", - "locationName":"duration" - }, - "UsagePrice":{ - "shape":"Float", - "documentation":"The usage price of the Reserved Instance, per hour.
", - "locationName":"usagePrice" - }, - "FixedPrice":{ - "shape":"Float", - "documentation":"The purchase price of the Reserved Instance.
", - "locationName":"fixedPrice" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of Reserved Instances purchased.
", - "locationName":"instanceCount" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance description.
", - "locationName":"productDescription" - }, - "State":{ - "shape":"ReservedInstanceState", - "documentation":"The state of the Reserved Instance purchase.
", - "locationName":"state" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "InstanceTenancy":{ - "shape":"Tenancy", - "documentation":"The tenancy of the reserved instance.
", - "locationName":"instanceTenancy" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
The Reserved Instance offering type.
", - "locationName":"offeringType" - }, - "RecurringCharges":{ - "shape":"RecurringChargesList", - "documentation":"The recurring charge tag assigned to the resource.
", - "locationName":"recurringCharges" - } - }, - "documentation":"Describes a Reserved Instance.
" - }, - "ReservedInstancesConfiguration":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the modified Reserved Instances.
", - "locationName":"availabilityZone" - }, - "Platform":{ - "shape":"String", - "documentation":"The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
", - "locationName":"platform" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of modified Reserved Instances.
", - "locationName":"instanceCount" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type for the modified Reserved Instances.
", - "locationName":"instanceType" - } - }, - "documentation":"Describes the configuration settings for the modified Reserved Instances.
" - }, - "ReservedInstancesConfigurationList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesConfiguration", - "locationName":"item" - } - }, - "ReservedInstancesId":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - } - }, - "documentation":"Describes the ID of a Reserved Instance.
" - }, - "ReservedInstancesIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ReservedInstancesId" - } - }, - "ReservedInstancesList":{ - "type":"list", - "member":{ - "shape":"ReservedInstances", - "locationName":"item" - } - }, - "ReservedInstancesListing":{ - "type":"structure", - "members":{ - "ReservedInstancesListingId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance listing.
", - "locationName":"reservedInstancesListingId" - }, - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "CreateDate":{ - "shape":"DateTime", - "documentation":"The time the listing was created.
", - "locationName":"createDate" - }, - "UpdateDate":{ - "shape":"DateTime", - "documentation":"The last modified timestamp of the listing.
", - "locationName":"updateDate" - }, - "Status":{ - "shape":"ListingStatus", - "documentation":"The status of the Reserved Instance listing.
", - "locationName":"status" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The reason for the current status of the Reserved Instance listing. The response can be blank.
", - "locationName":"statusMessage" - }, - "InstanceCounts":{ - "shape":"InstanceCountList", - "documentation":"The number of instances in this state.
", - "locationName":"instanceCounts" - }, - "PriceSchedules":{ - "shape":"PriceScheduleList", - "documentation":"The price of the Reserved Instance listing.
", - "locationName":"priceSchedules" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "ClientToken":{ - "shape":"String", - "documentation":"The idempotency token you provided when you created the listing.
", - "locationName":"clientToken" - } - }, - "documentation":"Describes a Reserved Instance listing.
" - }, - "ReservedInstancesListingList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesListing", - "locationName":"item" - } - }, - "ReservedInstancesModification":{ - "type":"structure", - "members":{ - "ReservedInstancesModificationId":{ - "shape":"String", - "documentation":"A unique ID for the Reserved Instance modification.
", - "locationName":"reservedInstancesModificationId" - }, - "ReservedInstancesIds":{ - "shape":"ReservedIntancesIds", - "documentation":"The IDs of one or more Reserved Instances.
", - "locationName":"reservedInstancesSet" - }, - "ModificationResults":{ - "shape":"ReservedInstancesModificationResultList", - "documentation":"Contains target configurations along with their corresponding new Reserved Instance IDs.
", - "locationName":"modificationResultSet" - }, - "CreateDate":{ - "shape":"DateTime", - "documentation":"The time when the modification request was created.
", - "locationName":"createDate" - }, - "UpdateDate":{ - "shape":"DateTime", - "documentation":"The time when the modification request was last updated.
", - "locationName":"updateDate" - }, - "EffectiveDate":{ - "shape":"DateTime", - "documentation":"The time for the modification to become effective.
", - "locationName":"effectiveDate" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the Reserved Instances modification request.
", - "locationName":"status" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"The reason for the status.
", - "locationName":"statusMessage" - }, - "ClientToken":{ - "shape":"String", - "documentation":"A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.
", - "locationName":"clientToken" - } - }, - "documentation":"Describes a Reserved Instance modification.
" - }, - "ReservedInstancesModificationIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ReservedInstancesModificationId" - } - }, - "ReservedInstancesModificationList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesModification", - "locationName":"item" - } - }, - "ReservedInstancesModificationResult":{ - "type":"structure", - "members":{ - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
", - "locationName":"reservedInstancesId" - }, - "TargetConfiguration":{ - "shape":"ReservedInstancesConfiguration", - "documentation":"The target Reserved Instances configurations supplied as part of the modification request.
", - "locationName":"targetConfiguration" - } - } - }, - "ReservedInstancesModificationResultList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesModificationResult", - "locationName":"item" - } - }, - "ReservedInstancesOffering":{ - "type":"structure", - "members":{ - "ReservedInstancesOfferingId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance offering.
", - "locationName":"reservedInstancesOfferingId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used.
", - "locationName":"instanceType" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
", - "locationName":"availabilityZone" - }, - "Duration":{ - "shape":"Long", - "documentation":"The duration of the Reserved Instance, in seconds.
", - "locationName":"duration" - }, - "UsagePrice":{ - "shape":"Float", - "documentation":"The usage price of the Reserved Instance, per hour.
", - "locationName":"usagePrice" - }, - "FixedPrice":{ - "shape":"Float", - "documentation":"The purchase price of the Reserved Instance.
", - "locationName":"fixedPrice" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance description.
", - "locationName":"productDescription" - }, - "InstanceTenancy":{ - "shape":"Tenancy", - "documentation":"The tenancy of the reserved instance.
", - "locationName":"instanceTenancy" - }, - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
The Reserved Instance offering type.
", - "locationName":"offeringType" - }, - "RecurringCharges":{ - "shape":"RecurringChargesList", - "documentation":"The recurring charge tag assigned to the resource.
", - "locationName":"recurringCharges" - }, - "Marketplace":{ - "shape":"Boolean", - "documentation":"Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.
The pricing details of the Reserved Instance offering.
", - "locationName":"pricingDetailsSet" - } - }, - "documentation":"Describes a Reserved Instance offering.
" - }, - "ReservedInstancesOfferingIdStringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ReservedInstancesOfferingList":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesOffering", - "locationName":"item" - } - }, - "ReservedIntancesIds":{ - "type":"list", - "member":{ - "shape":"ReservedInstancesId", - "locationName":"item" - } - }, - "ResetImageAttributeName":{ - "type":"string", - "enum":["launchPermission"] - }, - "ResetImageAttributeRequest":{ - "type":"structure", - "required":[ - "ImageId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
" - }, - "Attribute":{ - "shape":"ResetImageAttributeName", - "documentation":"The attribute to reset (currently you can only reset the launch permission attribute).
" - } - } - }, - "ResetInstanceAttributeRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "Attribute" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The attribute to reset.
", - "locationName":"attribute" - } - } - }, - "ResetNetworkInterfaceAttributeRequest":{ - "type":"structure", - "required":["NetworkInterfaceId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "SourceDestCheck":{ - "shape":"String", - "documentation":"The source/destination checking attribute. Resets the value to true.
The ID of the snapshot.
" - }, - "Attribute":{ - "shape":"SnapshotAttributeName", - "documentation":"The attribute to reset (currently only the attribute for permission to create volumes can be reset).
" - } - } - }, - "ResourceIdList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ResourceType":{ - "type":"string", - "enum":[ - "customer-gateway", - "dhcp-options", - "image", - "instance", - "internet-gateway", - "network-acl", - "network-interface", - "reserved-instances", - "route-table", - "snapshot", - "spot-instances-request", - "subnet", - "security-group", - "volume", - "vpc", - "vpn-connection", - "vpn-gateway" - ] - }, - "RestorableByStringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "RevokeSecurityGroupEgressRequest":{ - "type":"structure", - "required":["GroupId"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupName" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"sourceSecurityGroupOwnerId" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
", - "locationName":"cidrIp" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
", - "locationName":"ipPermissions" - } - } - }, - "RevokeSecurityGroupIngressRequest":{ - "type":"structure", - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "GroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the security group.
" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
" - }, - "SourceSecurityGroupName":{ - "shape":"String", - "documentation":"[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
" - }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
" - } - } - }, - "Route":{ - "type":"structure", - "members":{ - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block used for the destination match.
", - "locationName":"destinationCidrBlock" - }, - "GatewayId":{ - "shape":"String", - "documentation":"The ID of a gateway attached to your VPC.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of a NAT instance in your VPC.
", - "locationName":"instanceId" - }, - "InstanceOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the instance.
", - "locationName":"instanceOwnerId" - }, - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - }, - "State":{ - "shape":"RouteState", - "documentation":"The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).
Describes how the route was created.
CreateRouteTable indicates that route was automatically created when the route table was created.CreateRoute indicates that the route was manually added to the route table.EnableVgwRoutePropagation indicates that the route was propagated by route propagation.Describes a route in a route table.
" - }, - "RouteList":{ - "type":"list", - "member":{ - "shape":"Route", - "locationName":"item" - } - }, - "RouteOrigin":{ - "type":"string", - "enum":[ - "CreateRouteTable", - "CreateRoute", - "EnableVgwRoutePropagation" - ] - }, - "RouteState":{ - "type":"string", - "enum":[ - "active", - "blackhole" - ] - }, - "RouteTable":{ - "type":"structure", - "members":{ - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "Routes":{ - "shape":"RouteList", - "documentation":"The routes in the route table.
", - "locationName":"routeSet" - }, - "Associations":{ - "shape":"RouteTableAssociationList", - "documentation":"The associations between the route table and one or more subnets.
", - "locationName":"associationSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the route table.
", - "locationName":"tagSet" - }, - "PropagatingVgws":{ - "shape":"PropagatingVgwList", - "documentation":"Any virtual private gateway (VGW) propagating routes.
", - "locationName":"propagatingVgwSet" - } - }, - "documentation":"Describes a route table.
" - }, - "RouteTableAssociation":{ - "type":"structure", - "members":{ - "RouteTableAssociationId":{ - "shape":"String", - "documentation":"The ID of the association between a route table and a subnet.
", - "locationName":"routeTableAssociationId" - }, - "RouteTableId":{ - "shape":"String", - "documentation":"The ID of the route table.
", - "locationName":"routeTableId" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "Main":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the main route table.
", - "locationName":"main" - } - }, - "documentation":"Describes an association between a route table and a subnet.
" - }, - "RouteTableAssociationList":{ - "type":"list", - "member":{ - "shape":"RouteTableAssociation", - "locationName":"item" - } - }, - "RouteTableList":{ - "type":"list", - "member":{ - "shape":"RouteTable", - "locationName":"item" - } - }, - "RuleAction":{ - "type":"string", - "enum":[ - "allow", - "deny" - ] - }, - "RunInstancesMonitoringEnabled":{ - "type":"structure", - "required":["Enabled"], - "members":{ - "Enabled":{ - "shape":"Boolean", - "documentation":"Indicates whether monitoring is enabled for the instance.
", - "locationName":"enabled" - } - }, - "documentation":"Describes the monitoring for the instance.
" - }, - "RunInstancesRequest":{ - "type":"structure", - "required":[ - "ImageId", - "MinCount", - "MaxCount" - ], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI, which you can get by calling DescribeImages.
" - }, - "MinCount":{ - "shape":"Integer", - "documentation":"The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
" - }, - "MaxCount":{ - "shape":"Integer", - "documentation":"The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you launch an instance without specifying a key pair, you can't connect to the instance.
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
Default: Amazon EC2 uses the default security group.
", - "locationName":"SecurityGroup" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIdStringList", - "documentation":"One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
", - "locationName":"SecurityGroupId" - }, - "UserData":{ - "shape":"String", - "documentation":"The Base64-encoded MIME user data for the instances.
" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.
Default: m1.small
The placement for the instance.
" - }, - "KernelId":{ - "shape":"String", - "documentation":"The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.
The block device mapping.
", - "locationName":"BlockDeviceMapping" - }, - "Monitoring":{ - "shape":"RunInstancesMonitoringEnabled", - "documentation":"The monitoring for the instance.
" - }, - "SubnetId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the subnet to launch the instance into.
" - }, - "DisableApiTermination":{ - "shape":"Boolean", - "documentation":"If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.
Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.
Default: We select an IP address from the IP address range of the subnet.
", - "locationName":"privateIpAddress" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.
Constraints: Maximum 64 ASCII characters
", - "locationName":"clientToken" - }, - "AdditionalInfo":{ - "shape":"String", - "documentation":"Reserved.
", - "locationName":"additionalInfo" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceSpecificationList", - "documentation":"One or more network interfaces.
", - "locationName":"networkInterface" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfileSpecification", - "documentation":"The IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
", - "locationName":"bucket" - }, - "Prefix":{ - "shape":"String", - "documentation":"The beginning of the file name of the AMI.
", - "locationName":"prefix" - }, - "AWSAccessKeyId":{ - "shape":"String", - "documentation":"The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.
" - }, - "UploadPolicy":{ - "shape":"Blob", - "documentation":"A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
", - "locationName":"uploadPolicy" - }, - "UploadPolicySignature":{ - "shape":"String", - "documentation":"The signature of the Base64 encoded JSON document.
", - "locationName":"uploadPolicySignature" - } - }, - "documentation":"Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.
" - }, - "SecurityGroup":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the owner of the security group.
", - "locationName":"ownerId" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
", - "locationName":"groupName" - }, - "GroupId":{ - "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the security group.
", - "locationName":"groupDescription" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"One or more inbound rules associated with the security group.
", - "locationName":"ipPermissions" - }, - "IpPermissionsEgress":{ - "shape":"IpPermissionList", - "documentation":"[EC2-VPC] One or more outbound rules associated with the security group.
", - "locationName":"ipPermissionsEgress" - }, - "VpcId":{ - "shape":"String", - "documentation":"[EC2-VPC] The ID of the VPC for the security group.
", - "locationName":"vpcId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the security group.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a security group
" - }, - "SecurityGroupIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SecurityGroupId" - } - }, - "SecurityGroupList":{ - "type":"list", - "member":{ - "shape":"SecurityGroup", - "locationName":"item" - } - }, - "SecurityGroupStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SecurityGroup" - } - }, - "ShutdownBehavior":{ - "type":"string", - "enum":[ - "stop", - "terminate" - ] - }, - "Snapshot":{ - "type":"structure", - "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the snapshot.
", - "locationName":"snapshotId" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "State":{ - "shape":"SnapshotState", - "documentation":"The snapshot state.
", - "locationName":"status" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the snapshot was initiated.
", - "locationName":"startTime" - }, - "Progress":{ - "shape":"String", - "documentation":"The progress of the snapshot, as a percentage.
", - "locationName":"progress" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the Amazon EBS snapshot owner.
", - "locationName":"ownerId" - }, - "Description":{ - "shape":"String", - "documentation":"The description for the snapshot.
", - "locationName":"description" - }, - "VolumeSize":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiB.
", - "locationName":"volumeSize" - }, - "OwnerAlias":{ - "shape":"String", - "documentation":"The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
Any tags assigned to the snapshot.
", - "locationName":"tagSet" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Indicates whether the snapshot is encrypted.
", - "locationName":"encrypted" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the parent volume.
", - "locationName":"kmsKeyId" - } - }, - "documentation":"Describes a snapshot.
" - }, - "SnapshotAttributeName":{ - "type":"string", - "enum":[ - "productCodes", - "createVolumePermission" - ] - }, - "SnapshotIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SnapshotId" - } - }, - "SnapshotList":{ - "type":"list", - "member":{ - "shape":"Snapshot", - "locationName":"item" - } - }, - "SnapshotState":{ - "type":"string", - "enum":[ - "pending", - "completed", - "error" - ] - }, - "SpotDatafeedSubscription":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the account.
", - "locationName":"ownerId" - }, - "Bucket":{ - "shape":"String", - "documentation":"The Amazon S3 bucket where the Spot Instance data feed is located.
", - "locationName":"bucket" - }, - "Prefix":{ - "shape":"String", - "documentation":"The prefix that is prepended to data feed files.
", - "locationName":"prefix" - }, - "State":{ - "shape":"DatafeedSubscriptionState", - "documentation":"The state of the Spot Instance data feed subscription.
", - "locationName":"state" - }, - "Fault":{ - "shape":"SpotInstanceStateFault", - "documentation":"The fault codes for the Spot Instance request, if any.
", - "locationName":"fault" - } - }, - "documentation":"Describes the data feed for a Spot Instance.
" - }, - "SpotInstanceRequest":{ - "type":"structure", - "members":{ - "SpotInstanceRequestId":{ - "shape":"String", - "documentation":"The ID of the Spot Instance request.
", - "locationName":"spotInstanceRequestId" - }, - "SpotPrice":{ - "shape":"String", - "documentation":"The maximum hourly price for any Spot Instance launched to fulfill the request.
", - "locationName":"spotPrice" - }, - "Type":{ - "shape":"SpotInstanceType", - "documentation":"The Spot Instance request type.
", - "locationName":"type" - }, - "State":{ - "shape":"SpotInstanceState", - "documentation":"The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.
", - "locationName":"state" - }, - "Fault":{ - "shape":"SpotInstanceStateFault", - "documentation":"The fault codes for the Spot Instance request, if any.
", - "locationName":"fault" - }, - "Status":{ - "shape":"SpotInstanceStatus", - "documentation":"The status code and status message describing the Spot Instance request.
", - "locationName":"status" - }, - "ValidFrom":{ - "shape":"DateTime", - "documentation":"The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
", - "locationName":"validFrom" - }, - "ValidUntil":{ - "shape":"DateTime", - "documentation":"The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.
", - "locationName":"validUntil" - }, - "LaunchGroup":{ - "shape":"String", - "documentation":"The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
", - "locationName":"launchGroup" - }, - "AvailabilityZoneGroup":{ - "shape":"String", - "documentation":"The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
", - "locationName":"availabilityZoneGroup" - }, - "LaunchSpecification":{ - "shape":"LaunchSpecification", - "documentation":"Additional information for launching instances.
", - "locationName":"launchSpecification" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID, if an instance has been launched to fulfill the Spot Instance request.
", - "locationName":"instanceId" - }, - "CreateTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the Spot Instance request was created.
", - "locationName":"createTime" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The product description associated with the Spot Instance.
", - "locationName":"productDescription" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "LaunchedAvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the bid is launched.
", - "locationName":"launchedAvailabilityZone" - } - }, - "documentation":"Describe a Spot Instance request.
" - }, - "SpotInstanceRequestIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SpotInstanceRequestId" - } - }, - "SpotInstanceRequestList":{ - "type":"list", - "member":{ - "shape":"SpotInstanceRequest", - "locationName":"item" - } - }, - "SpotInstanceState":{ - "type":"string", - "enum":[ - "open", - "active", - "closed", - "cancelled", - "failed" - ] - }, - "SpotInstanceStateFault":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The reason code for the Spot Instance state change.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"The message for the Spot Instance state change.
", - "locationName":"message" - } - }, - "documentation":"Describes a Spot Instance state change.
" - }, - "SpotInstanceStatus":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The status code of the request.
", - "locationName":"code" - }, - "UpdateTime":{ - "shape":"DateTime", - "documentation":"The time of the most recent status update.
", - "locationName":"updateTime" - }, - "Message":{ - "shape":"String", - "documentation":"The description for the status code for the Spot request.
", - "locationName":"message" - } - }, - "documentation":"Describes a Spot Instance request.
" - }, - "SpotInstanceType":{ - "type":"string", - "enum":[ - "one-time", - "persistent" - ] - }, - "SpotPlacement":{ - "type":"structure", - "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone.
", - "locationName":"availabilityZone" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the placement group (for cluster instances).
", - "locationName":"groupName" - } - }, - "documentation":"Describes Spot Instance placement.
" - }, - "SpotPrice":{ - "type":"structure", - "members":{ - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"A general description of the AMI.
", - "locationName":"productDescription" - }, - "SpotPrice":{ - "shape":"String", - "documentation":"The maximum price you will pay to launch one or more Spot Instances.
", - "locationName":"spotPrice" - }, - "Timestamp":{ - "shape":"DateTime", - "documentation":"The date and time the request was created.
", - "locationName":"timestamp" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone.
", - "locationName":"availabilityZone" - } - }, - "documentation":"Describes the Spot Price.
" - }, - "SpotPriceHistoryList":{ - "type":"list", - "member":{ - "shape":"SpotPrice", - "locationName":"item" - } - }, - "StartInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - }, - "AdditionalInfo":{ - "shape":"String", - "documentation":"Reserved.
", - "locationName":"additionalInfo" - }, - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - } - } - }, - "StartInstancesResult":{ - "type":"structure", - "members":{ - "StartingInstances":{ - "shape":"InstanceStateChangeList", - "documentation":"Information about one or more started instances.
", - "locationName":"instancesSet" - } - } - }, - "StateReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The reason code for the state change.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"The message for the state change.
Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
Describes a state change.
" - }, - "StatusName":{ - "type":"string", - "enum":["reachability"] - }, - "StatusType":{ - "type":"string", - "enum":[ - "passed", - "failed", - "insufficient-data" - ] - }, - "StopInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - }, - "Force":{ - "shape":"Boolean", - "documentation":"Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Information about one or more stopped instances.
", - "locationName":"instancesSet" - } - } - }, - "Storage":{ - "type":"structure", - "members":{ - "S3":{ - "shape":"S3Storage", - "documentation":"An Amazon S3 storage location.
" - } - }, - "documentation":"Describes the storage location for an instance store-backed AMI.
" - }, - "String":{"type":"string"}, - "Subnet":{ - "type":"structure", - "members":{ - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "State":{ - "shape":"SubnetState", - "documentation":"The current state of the subnet.
", - "locationName":"state" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC the subnet is in.
", - "locationName":"vpcId" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The CIDR block assigned to the subnet.
", - "locationName":"cidrBlock" - }, - "AvailableIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.
", - "locationName":"availableIpAddressCount" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the subnet.
", - "locationName":"availabilityZone" - }, - "DefaultForAz":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the default subnet for the Availability Zone.
", - "locationName":"defaultForAz" - }, - "MapPublicIpOnLaunch":{ - "shape":"Boolean", - "documentation":"Indicates whether instances launched in this subnet receive a public IP address.
", - "locationName":"mapPublicIpOnLaunch" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the subnet.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a subnet.
" - }, - "SubnetIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SubnetId" - } - }, - "SubnetList":{ - "type":"list", - "member":{ - "shape":"Subnet", - "locationName":"item" - } - }, - "SubnetState":{ - "type":"string", - "enum":[ - "pending", - "available" - ] - }, - "SummaryStatus":{ - "type":"string", - "enum":[ - "ok", - "impaired", - "insufficient-data", - "not-applicable" - ] - }, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
", - "locationName":"value" - } - }, - "documentation":"Describes a tag.
" - }, - "TagDescription":{ - "type":"structure", - "members":{ - "ResourceId":{ - "shape":"String", - "documentation":"The ID of the resource. For example, ami-1a2b3c4d.
The resource type.
", - "locationName":"resourceType" - }, - "Key":{ - "shape":"String", - "documentation":"The tag key.
", - "locationName":"key" - }, - "Value":{ - "shape":"String", - "documentation":"The tag value.
", - "locationName":"value" - } - }, - "documentation":"Describes a tag.
" - }, - "TagDescriptionList":{ - "type":"list", - "member":{ - "shape":"TagDescription", - "locationName":"item" - } - }, - "TagList":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"item" - } - }, - "TelemetryStatus":{ - "type":"string", - "enum":[ - "UP", - "DOWN" - ] - }, - "Tenancy":{ - "type":"string", - "enum":[ - "default", - "dedicated" - ] - }, - "TerminateInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "TerminateInstancesResult":{ - "type":"structure", - "members":{ - "TerminatingInstances":{ - "shape":"InstanceStateChangeList", - "documentation":"Information about one or more terminated instances.
", - "locationName":"instancesSet" - } - } - }, - "UnassignPrivateIpAddressesRequest":{ - "type":"structure", - "required":[ - "NetworkInterfaceId", - "PrivateIpAddresses" - ], - "members":{ - "NetworkInterfaceId":{ - "shape":"String", - "documentation":"The ID of the network interface.
", - "locationName":"networkInterfaceId" - }, - "PrivateIpAddresses":{ - "shape":"PrivateIpAddressStringList", - "documentation":"The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
", - "locationName":"privateIpAddress" - } - } - }, - "UnmonitorInstancesRequest":{ - "type":"structure", - "required":["InstanceIds"], - "members":{ - "DryRun":{ - "shape":"Boolean", - "locationName":"dryRun" - }, - "InstanceIds":{ - "shape":"InstanceIdStringList", - "documentation":"One or more instance IDs.
", - "locationName":"InstanceId" - } - } - }, - "UnmonitorInstancesResult":{ - "type":"structure", - "members":{ - "InstanceMonitorings":{ - "shape":"InstanceMonitoringList", - "documentation":"Monitoring information for one or more instances.
", - "locationName":"instancesSet" - } - } - }, - "UserData":{ - "type":"structure", - "members":{ - "Data":{ - "shape":"String", - "locationName":"data" - } - } - }, - "UserGroupStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"UserGroup" - } - }, - "UserIdGroupPair":{ - "type":"structure", - "members":{ - "UserId":{ - "shape":"String", - "documentation":"The ID of an AWS account.
", - "locationName":"userId" - }, - "GroupName":{ - "shape":"String", - "documentation":"The ID of the security group owned by the specified AWS account.
", - "locationName":"groupName" - }, - "GroupId":{ - "shape":"String", - "documentation":"The name of the security group in the specified AWS account.
", - "locationName":"groupId" - } - }, - "documentation":"Describes a security group and AWS account ID pair for EC2-Classic.
" - }, - "UserIdGroupPairList":{ - "type":"list", - "member":{ - "shape":"UserIdGroupPair", - "locationName":"item" - } - }, - "UserIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"UserId" - } - }, - "ValueStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"item" - } - }, - "VgwTelemetry":{ - "type":"structure", - "members":{ - "OutsideIpAddress":{ - "shape":"String", - "documentation":"The Internet-routable IP address of the virtual private gateway's outside interface.
", - "locationName":"outsideIpAddress" - }, - "Status":{ - "shape":"TelemetryStatus", - "documentation":"The status of the VPN tunnel.
", - "locationName":"status" - }, - "LastStatusChange":{ - "shape":"DateTime", - "documentation":"The date and time of the last change in status.
", - "locationName":"lastStatusChange" - }, - "StatusMessage":{ - "shape":"String", - "documentation":"If an error occurs, a description of the error.
", - "locationName":"statusMessage" - }, - "AcceptedRouteCount":{ - "shape":"Integer", - "documentation":"The number of accepted routes.
", - "locationName":"acceptedRouteCount" - } - }, - "documentation":"Describes telemetry for a VPN tunnel.
" - }, - "VgwTelemetryList":{ - "type":"list", - "member":{ - "shape":"VgwTelemetry", - "locationName":"item" - } - }, - "VirtualizationType":{ - "type":"string", - "enum":[ - "hvm", - "paravirtual" - ] - }, - "Volume":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "Size":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiBs.
", - "locationName":"size" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The snapshot from which the volume was created, if applicable.
", - "locationName":"snapshotId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the volume.
", - "locationName":"availabilityZone" - }, - "State":{ - "shape":"VolumeState", - "documentation":"The volume state.
", - "locationName":"status" - }, - "CreateTime":{ - "shape":"DateTime", - "documentation":"The time stamp when volume creation was initiated.
", - "locationName":"createTime" - }, - "Attachments":{ - "shape":"VolumeAttachmentList", - "locationName":"attachmentSet" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the volume.
", - "locationName":"tagSet" - }, - "VolumeType":{ - "shape":"VolumeType", - "documentation":"The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.
Indicates whether the volume will be encrypted.
", - "locationName":"encrypted" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.
", - "locationName":"kmsKeyId" - } - }, - "documentation":"Describes a volume.
" - }, - "VolumeAttachment":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "Device":{ - "shape":"String", - "documentation":"The device name.
", - "locationName":"device" - }, - "State":{ - "shape":"VolumeAttachmentState", - "documentation":"The attachment state of the volume.
", - "locationName":"status" - }, - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" - }, - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the Amazon EBS volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - } - }, - "documentation":"Describes volume attachment details.
" - }, - "VolumeAttachmentList":{ - "type":"list", - "member":{ - "shape":"VolumeAttachment", - "locationName":"item" - } - }, - "VolumeAttachmentState":{ - "type":"string", - "enum":[ - "attaching", - "attached", - "detaching", - "detached" - ] - }, - "VolumeAttributeName":{ - "type":"string", - "enum":[ - "autoEnableIO", - "productCodes" - ] - }, - "VolumeDetail":{ - "type":"structure", - "required":["Size"], - "members":{ - "Size":{ - "shape":"Long", - "documentation":"The size of the volume, in GiB.
", - "locationName":"size" - } - }, - "documentation":"Describes an Amazon EBS volume.
" - }, - "VolumeIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VolumeId" - } - }, - "VolumeList":{ - "type":"list", - "member":{ - "shape":"Volume", - "locationName":"item" - } - }, - "VolumeState":{ - "type":"string", - "enum":[ - "creating", - "available", - "in-use", - "deleting", - "deleted", - "error" - ] - }, - "VolumeStatusAction":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The code identifying the operation, for example, enable-volume-io.
A description of the operation.
", - "locationName":"description" - }, - "EventType":{ - "shape":"String", - "documentation":"The event type associated with this operation.
", - "locationName":"eventType" - }, - "EventId":{ - "shape":"String", - "documentation":"The ID of the event associated with this operation.
", - "locationName":"eventId" - } - }, - "documentation":"Describes a volume status operation code.
" - }, - "VolumeStatusActionsList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusAction", - "locationName":"item" - } - }, - "VolumeStatusDetails":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"VolumeStatusName", - "documentation":"The name of the volume status.
", - "locationName":"name" - }, - "Status":{ - "shape":"String", - "documentation":"The intended status of the volume status.
", - "locationName":"status" - } - }, - "documentation":"Describes a volume status.
" - }, - "VolumeStatusDetailsList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusDetails", - "locationName":"item" - } - }, - "VolumeStatusEvent":{ - "type":"structure", - "members":{ - "EventType":{ - "shape":"String", - "documentation":"The type of this event.
", - "locationName":"eventType" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the event.
", - "locationName":"description" - }, - "NotBefore":{ - "shape":"DateTime", - "documentation":"The earliest start time of the event.
", - "locationName":"notBefore" - }, - "NotAfter":{ - "shape":"DateTime", - "documentation":"The latest end time of the event.
", - "locationName":"notAfter" - }, - "EventId":{ - "shape":"String", - "documentation":"The ID of this event.
", - "locationName":"eventId" - } - }, - "documentation":"Describes a volume status event.
" - }, - "VolumeStatusEventsList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusEvent", - "locationName":"item" - } - }, - "VolumeStatusInfo":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"VolumeStatusInfoStatus", - "documentation":"The status of the volume.
", - "locationName":"status" - }, - "Details":{ - "shape":"VolumeStatusDetailsList", - "documentation":"The details of the volume status.
", - "locationName":"details" - } - }, - "documentation":"Describes the status of a volume.
" - }, - "VolumeStatusInfoStatus":{ - "type":"string", - "enum":[ - "ok", - "impaired", - "insufficient-data" - ] - }, - "VolumeStatusItem":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
", - "locationName":"volumeId" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone of the volume.
", - "locationName":"availabilityZone" - }, - "VolumeStatus":{ - "shape":"VolumeStatusInfo", - "documentation":"The volume status.
", - "locationName":"volumeStatus" - }, - "Events":{ - "shape":"VolumeStatusEventsList", - "documentation":"A list of events associated with the volume.
", - "locationName":"eventsSet" - }, - "Actions":{ - "shape":"VolumeStatusActionsList", - "documentation":"The details of the operation.
", - "locationName":"actionsSet" - } - }, - "documentation":"Describes the volume status.
" - }, - "VolumeStatusList":{ - "type":"list", - "member":{ - "shape":"VolumeStatusItem", - "locationName":"item" - } - }, - "VolumeStatusName":{ - "type":"string", - "enum":[ - "io-enabled", - "io-performance" - ] - }, - "VolumeType":{ - "type":"string", - "enum":[ - "standard", - "io1", - "gp2" - ] - }, - "Vpc":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "State":{ - "shape":"VpcState", - "documentation":"The current state of the VPC.
", - "locationName":"state" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The CIDR block for the VPC.
", - "locationName":"cidrBlock" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).
Any tags assigned to the VPC.
", - "locationName":"tagSet" - }, - "InstanceTenancy":{ - "shape":"Tenancy", - "documentation":"The allowed tenancy of instances launched into the VPC.
", - "locationName":"instanceTenancy" - }, - "IsDefault":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPC is the default VPC.
", - "locationName":"isDefault" - } - }, - "documentation":"Describes a VPC.
" - }, - "VpcAttachment":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "State":{ - "shape":"AttachmentStatus", - "documentation":"The current state of the attachment.
", - "locationName":"state" - } - }, - "documentation":"Describes an attachment between a virtual private gateway and a VPC.
" - }, - "VpcAttachmentList":{ - "type":"list", - "member":{ - "shape":"VpcAttachment", - "locationName":"item" - } - }, - "VpcAttributeName":{ - "type":"string", - "enum":[ - "enableDnsSupport", - "enableDnsHostnames" - ] - }, - "VpcClassicLink":{ - "type":"structure", - "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, - "ClassicLinkEnabled":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPC is enabled for ClassicLink.
", - "locationName":"classicLinkEnabled" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the VPC.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes whether a VPC is enabled for ClassicLink.
" - }, - "VpcClassicLinkIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpcId" - } - }, - "VpcClassicLinkList":{ - "type":"list", - "member":{ - "shape":"VpcClassicLink", - "locationName":"item" - } - }, - "VpcIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpcId" - } - }, - "VpcList":{ - "type":"list", - "member":{ - "shape":"Vpc", - "locationName":"item" - } - }, - "VpcPeeringConnection":{ - "type":"structure", - "members":{ - "AccepterVpcInfo":{ - "shape":"VpcPeeringConnectionVpcInfo", - "documentation":"The information of the peer VPC.
", - "locationName":"accepterVpcInfo" - }, - "ExpirationTime":{ - "shape":"DateTime", - "documentation":"The time that an unaccepted VPC peering connection will expire.
", - "locationName":"expirationTime" - }, - "RequesterVpcInfo":{ - "shape":"VpcPeeringConnectionVpcInfo", - "documentation":"The information of the requester VPC.
", - "locationName":"requesterVpcInfo" - }, - "Status":{ - "shape":"VpcPeeringConnectionStateReason", - "documentation":"The status of the VPC peering connection.
", - "locationName":"status" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the resource.
", - "locationName":"tagSet" - }, - "VpcPeeringConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPC peering connection.
", - "locationName":"vpcPeeringConnectionId" - } - }, - "documentation":"Describes a VPC peering connection.
" - }, - "VpcPeeringConnectionList":{ - "type":"list", - "member":{ - "shape":"VpcPeeringConnection", - "locationName":"item" - } - }, - "VpcPeeringConnectionStateReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"String", - "documentation":"The status of the VPC peering connection.
", - "locationName":"code" - }, - "Message":{ - "shape":"String", - "documentation":"A message that provides more information about the status, if applicable.
", - "locationName":"message" - } - }, - "documentation":"Describes the status of a VPC peering connection.
" - }, - "VpcPeeringConnectionVpcInfo":{ - "type":"structure", - "members":{ - "CidrBlock":{ - "shape":"String", - "documentation":"The CIDR block for the VPC.
", - "locationName":"cidrBlock" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the VPC owner.
", - "locationName":"ownerId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - } - }, - "documentation":"Describes a VPC in a VPC peering connection.
" - }, - "VpcState":{ - "type":"string", - "enum":[ - "pending", - "available" - ] - }, - "VpnConnection":{ - "type":"structure", - "members":{ - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
", - "locationName":"vpnConnectionId" - }, - "State":{ - "shape":"VpnState", - "documentation":"The current state of the VPN connection.
", - "locationName":"state" - }, - "CustomerGatewayConfiguration":{ - "shape":"String", - "documentation":"The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
The type of VPN connection.
", - "locationName":"type" - }, - "CustomerGatewayId":{ - "shape":"String", - "documentation":"The ID of the customer gateway at your end of the VPN connection.
", - "locationName":"customerGatewayId" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway at the AWS side of the VPN connection.
", - "locationName":"vpnGatewayId" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the VPN connection.
", - "locationName":"tagSet" - }, - "VgwTelemetry":{ - "shape":"VgwTelemetryList", - "documentation":"Information about the VPN tunnel.
", - "locationName":"vgwTelemetry" - }, - "Options":{ - "shape":"VpnConnectionOptions", - "documentation":"The VPN connection options.
", - "locationName":"options" - }, - "Routes":{ - "shape":"VpnStaticRouteList", - "documentation":"The static routes associated with the VPN connection.
", - "locationName":"routes" - } - }, - "documentation":"Describes a VPN connection.
" - }, - "VpnConnectionIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpnConnectionId" - } - }, - "VpnConnectionList":{ - "type":"list", - "member":{ - "shape":"VpnConnection", - "locationName":"item" - } - }, - "VpnConnectionOptions":{ - "type":"structure", - "members":{ - "StaticRoutesOnly":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
", - "locationName":"staticRoutesOnly" - } - }, - "documentation":"Describes VPN connection options.
" - }, - "VpnConnectionOptionsSpecification":{ - "type":"structure", - "members":{ - "StaticRoutesOnly":{ - "shape":"Boolean", - "documentation":"Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
", - "locationName":"staticRoutesOnly" - } - }, - "documentation":"Describes VPN connection options.
" - }, - "VpnGateway":{ - "type":"structure", - "members":{ - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
", - "locationName":"vpnGatewayId" - }, - "State":{ - "shape":"VpnState", - "documentation":"The current state of the virtual private gateway.
", - "locationName":"state" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection the virtual private gateway supports.
", - "locationName":"type" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where the virtual private gateway was created.
", - "locationName":"availabilityZone" - }, - "VpcAttachments":{ - "shape":"VpcAttachmentList", - "documentation":"Any VPCs attached to the virtual private gateway.
", - "locationName":"attachments" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the virtual private gateway.
", - "locationName":"tagSet" - } - }, - "documentation":"Describes a virtual private gateway.
" - }, - "VpnGatewayIdStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpnGatewayId" - } - }, - "VpnGatewayList":{ - "type":"list", - "member":{ - "shape":"VpnGateway", - "locationName":"item" - } - }, - "VpnState":{ - "type":"string", - "enum":[ - "pending", - "available", - "deleting", - "deleted" - ] - }, - "VpnStaticRoute":{ - "type":"structure", - "members":{ - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The CIDR block associated with the local subnet of the customer data center.
", - "locationName":"destinationCidrBlock" - }, - "Source":{ - "shape":"VpnStaticRouteSource", - "documentation":"Indicates how the routes were provided.
", - "locationName":"source" - }, - "State":{ - "shape":"VpnState", - "documentation":"The current state of the static route.
", - "locationName":"state" - } - }, - "documentation":"Describes a static route for a VPN connection.
" - }, - "VpnStaticRouteList":{ - "type":"list", - "member":{ - "shape":"VpnStaticRoute", - "locationName":"item" - } - }, - "VpnStaticRouteSource":{ - "type":"string", - "enum":["Static"] - }, - "ZoneNameStringList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ZoneName" - } - }, - "NewDhcpConfigurationList":{ - "type":"list", - "member":{ - "shape":"NewDhcpConfiguration", - "locationName":"item" - } - }, - "NewDhcpConfiguration":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "locationName":"key" - }, - "Values":{ - "shape":"ValueStringList", - "locationName":"Value" - } - } - }, - "DhcpConfigurationValueList":{ - "type":"list", - "member":{ - "shape":"AttributeValue", - "locationName":"item" - } - }, - "Blob":{"type":"blob"}, - "BlobAttributeValue":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"Blob", - "locationName":"value" - } - } - }, - "RequestSpotLaunchSpecification":{ - "type":"structure", - "members":{ - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair.
", - "locationName":"keyName" - }, - "SecurityGroups":{ - "shape":"ValueStringList", - "locationName":"SecurityGroup" - }, - "UserData":{ - "shape":"String", - "documentation":"The Base64-encoded MIME user data to make available to the instances.
", - "locationName":"userData" - }, - "AddressingType":{ - "shape":"String", - "documentation":"Deprecated.
", - "locationName":"addressingType" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
Default: m1.small
The placement information for the instance.
", - "locationName":"placement" - }, - "KernelId":{ - "shape":"String", - "documentation":"The ID of the kernel.
", - "locationName":"kernelId" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The ID of the RAM disk.
", - "locationName":"ramdiskId" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"One or more block device mapping entries.
", - "locationName":"blockDeviceMapping" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which to launch the instance.
", - "locationName":"subnetId" - }, - "NetworkInterfaces":{ - "shape":"InstanceNetworkInterfaceSpecificationList", - "documentation":"One or more network interfaces.
", - "locationName":"NetworkInterface" - }, - "IamInstanceProfile":{ - "shape":"IamInstanceProfileSpecification", - "documentation":"The IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Describes the launch specification for an instance.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.paginators.json deleted file mode 100644 index b643e696c1..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.paginators.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "pagination": { - "DescribeInstanceStatus": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "InstanceStatuses" - }, - "DescribeInstances": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Reservations" - }, - "DescribeReservedInstancesModifications": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "ReservedInstancesModifications" - }, - "DescribeReservedInstancesOfferings": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ReservedInstancesOfferings" - }, - "DescribeSpotPriceHistory": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "SpotPriceHistory" - }, - "DescribeTags": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Tags" - }, - "DescribeVolumeStatus": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "VolumeStatuses" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.waiters.json deleted file mode 100644 index fb8c16bdf2..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ec2/2014-10-01.waiters.json +++ /dev/null @@ -1,341 +0,0 @@ -{ - "version": 2, - "waiters": { - "BundleTaskComplete": { - "delay": 15, - "operation": "DescribeBundleTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "complete", - "matcher": "pathAll", - "state": "success", - "argument": "BundleTasks[].State" - }, - { - "expected": "failed", - "matcher": "pathAny", - "state": "failure", - "argument": "BundleTasks[].State" - } - ] - }, - "ConversionTaskCancelled": { - "delay": 15, - "operation": "DescribeConversionTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "cancelled", - "matcher": "pathAll", - "state": "success", - "argument": "ConversionTasks[].State" - } - ] - }, - "ConversionTaskCompleted": { - "delay": 15, - "operation": "DescribeConversionTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "completed", - "matcher": "pathAll", - "state": "success", - "argument": "ConversionTasks[].State" - }, - { - "expected": "cancelled", - "matcher": "pathAny", - "state": "failure", - "argument": "ConversionTasks[].State" - }, - { - "expected": "cancelling", - "matcher": "pathAny", - "state": "failure", - "argument": "ConversionTasks[].State" - } - ] - }, - "ConversionTaskDeleted": { - "delay": 15, - "operation": "DescribeConversionTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "ConversionTasks[].State" - } - ] - }, - "CustomerGatewayAvailable": { - "delay": 15, - "operation": "DescribeCustomerGateways", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "CustomerGateways[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "CustomerGateways[].State" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "CustomerGateways[].State" - } - ] - }, - "ExportTaskCancelled": { - "delay": 15, - "operation": "DescribeExportTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "cancelled", - "matcher": "pathAll", - "state": "success", - "argument": "ExportTasks[].State" - } - ] - }, - "ExportTaskCompleted": { - "delay": 15, - "operation": "DescribeExportTasks", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "completed", - "matcher": "pathAll", - "state": "success", - "argument": "ExportTasks[].State" - } - ] - }, - "InstanceRunning": { - "delay": 15, - "operation": "DescribeInstances", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "running", - "matcher": "pathAll", - "state": "success", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "shutting-down", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "terminated", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "stopping", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - } - ] - }, - "InstanceStopped": { - "delay": 15, - "operation": "DescribeInstances", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "stopped", - "matcher": "pathAll", - "state": "success", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "pending", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "terminated", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - } - ] - }, - "InstanceTerminated": { - "delay": 15, - "operation": "DescribeInstances", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "terminated", - "matcher": "pathAll", - "state": "success", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "pending", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - }, - { - "expected": "stopping", - "matcher": "pathAny", - "state": "failure", - "argument": "Reservations[].Instances[].State.Name" - } - ] - }, - "SnapshotCompleted": { - "delay": 15, - "operation": "DescribeSnapshots", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "completed", - "matcher": "pathAll", - "state": "success", - "argument": "Snapshots[].State" - } - ] - }, - "SubnetAvailable": { - "delay": 15, - "operation": "DescribeSubnets", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Subnets[].State" - } - ] - }, - "VolumeAvailable": { - "delay": 15, - "operation": "DescribeVolumes", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Volumes[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "Volumes[].State" - } - ] - }, - "VolumeDeleted": { - "delay": 15, - "operation": "DescribeVolumes", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "Volumes[].State" - } - ] - }, - "VolumeInUse": { - "delay": 15, - "operation": "DescribeVolumes", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "in-use", - "matcher": "pathAll", - "state": "success", - "argument": "Volumes[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "Volumes[].State" - } - ] - }, - "VpcAvailable": { - "delay": 15, - "operation": "DescribeVpcs", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Vpcs[].State" - } - ] - }, - "VpnConnectionAvailable": { - "delay": 15, - "operation": "DescribeVpnConnections", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "VpnConnections[].State" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "VpnConnections[].State" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "VpnConnections[].State" - } - ] - }, - "VpnConnectionDeleted": { - "delay": 15, - "operation": "DescribeVpnConnections", - "maxAttempts": 40, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "VpnConnections[].State" - }, - { - "expected": "pending", - "matcher": "pathAny", - "state": "failure", - "argument": "VpnConnections[].State" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ecs/2014-11-13.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/ecs/2014-11-13.normal.json deleted file mode 100644 index b973fcb04a..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ecs/2014-11-13.normal.json +++ /dev/null @@ -1,1393 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-11-13", - "endpointPrefix":"ecs", - "serviceAbbreviation":"Amazon ECS", - "serviceFullName":"Amazon EC2 Container Service", - "signatureVersion":"v4", - "signingName":"ecs", - "xmlNamespace":"http://ecs.amazonaws.com/doc/2014-11-13/", - "protocol":"query" - }, - "documentation":"Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of Amazon EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
", - "operations":{ - "CreateCluster":{ - "name":"CreateCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateClusterRequest"}, - "output":{ - "shape":"CreateClusterResponse", - "resultWrapper":"CreateClusterResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Creates a new Amazon ECS cluster. By default, your account will receive a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
During the preview, each account is limited to two clusters.
These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" - }, - "DeregisterContainerInstance":{ - "name":"DeregisterContainerInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterContainerInstanceRequest"}, - "output":{ - "shape":"DeregisterContainerInstanceResponse", - "resultWrapper":"DeregisterContainerInstanceResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.
" - }, - "DeregisterTaskDefinition":{ - "name":"DeregisterTaskDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterTaskDefinitionRequest"}, - "output":{ - "shape":"DeregisterTaskDefinitionResponse", - "resultWrapper":"DeregisterTaskDefinitionResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Deregisters the specified task definition. You will no longer be able to run tasks from this definition after deregistration.
" - }, - "DescribeClusters":{ - "name":"DescribeClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClustersRequest"}, - "output":{ - "shape":"DescribeClustersResponse", - "resultWrapper":"DescribeClustersResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Describes one or more of your clusters.
" - }, - "DescribeContainerInstances":{ - "name":"DescribeContainerInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeContainerInstancesRequest"}, - "output":{ - "shape":"DescribeContainerInstancesResponse", - "resultWrapper":"DescribeContainerInstancesResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
" - }, - "DescribeTaskDefinition":{ - "name":"DescribeTaskDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTaskDefinitionRequest"}, - "output":{ - "shape":"DescribeTaskDefinitionResponse", - "resultWrapper":"DescribeTaskDefinitionResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Describes a task definition.
" - }, - "DescribeTasks":{ - "name":"DescribeTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTasksRequest"}, - "output":{ - "shape":"DescribeTasksResponse", - "resultWrapper":"DescribeTasksResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Describes a specified task or tasks.
" - }, - "DiscoverPollEndpoint":{ - "name":"DiscoverPollEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DiscoverPollEndpointRequest"}, - "output":{ - "shape":"DiscoverPollEndpointResponse", - "resultWrapper":"DiscoverPollEndpointResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
" - }, - "ListClusters":{ - "name":"ListClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClustersRequest"}, - "output":{ - "shape":"ListClustersResponse", - "resultWrapper":"ListClustersResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Returns a list of existing clusters.
" - }, - "ListContainerInstances":{ - "name":"ListContainerInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListContainerInstancesRequest"}, - "output":{ - "shape":"ListContainerInstancesResponse", - "resultWrapper":"ListContainerInstancesResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Returns a list of container instances in a specified cluster.
" - }, - "ListTaskDefinitions":{ - "name":"ListTaskDefinitions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTaskDefinitionsRequest"}, - "output":{ - "shape":"ListTaskDefinitionsResponse", - "resultWrapper":"ListTaskDefinitionsResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter.
These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Returns a list of tasks for a specified cluster. You can filter the results by family name or by a particular container instance with the family and containerInstance parameters.
These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.
" - }, - "RegisterTaskDefinition":{ - "name":"RegisterTaskDefinition", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterTaskDefinitionRequest"}, - "output":{ - "shape":"RegisterTaskDefinitionResponse", - "resultWrapper":"RegisterTaskDefinitionResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Registers a new task definition from the supplied family and containerDefinitions.
These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.
These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.
These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"Stops a running task.
" - }, - "SubmitContainerStateChange":{ - "name":"SubmitContainerStateChange", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SubmitContainerStateChangeRequest"}, - "output":{ - "shape":"SubmitContainerStateChangeResponse", - "resultWrapper":"SubmitContainerStateChangeResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
" - }, - "SubmitTaskStateChange":{ - "name":"SubmitTaskStateChange", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SubmitTaskStateChangeRequest"}, - "output":{ - "shape":"SubmitTaskStateChangeResponse", - "resultWrapper":"SubmitTaskStateChangeResult" - }, - "errors":[ - { - "shape":"ServerException", - "exception":true, - "documentation":"These errors are usually caused by a server-side issue.
" - }, - { - "shape":"ClientException", - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - } - ], - "documentation":"This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
" - } - }, - "shapes":{ - "Boolean":{"type":"boolean"}, - "BoxedBoolean":{ - "type":"boolean", - "box":true - }, - "BoxedInteger":{ - "type":"integer", - "box":true - }, - "ClientException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "exception":true, - "documentation":"These errors are usually caused by something the client did, such as use an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specify an identifier that is not valid.
" - }, - "Cluster":{ - "type":"structure", - "members":{ - "clusterArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
A user-generated string that you can use to identify your cluster.
" - }, - "status":{ - "shape":"String", - "documentation":"The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
During the preview, each account is limited to two clusters.
The Amazon Resource Name (ARN) of the container.
" - }, - "taskArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the task.
" - }, - "name":{ - "shape":"String", - "documentation":"The name of the container.
" - }, - "lastStatus":{ - "shape":"String", - "documentation":"The last known status of the container.
" - }, - "exitCode":{ - "shape":"BoxedInteger", - "documentation":"The exit code returned from the container.
" - }, - "reason":{ - "shape":"String", - "documentation":"A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.
" - }, - "networkBindings":{"shape":"NetworkBindings"} - } - }, - "ContainerDefinition":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
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 repository-url/image:tag.
The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
" - }, - "links":{ - "shape":"StringList", - "documentation":"The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
The list of port mappings for the container.
" - }, - "essential":{ - "shape":"BoxedBoolean", - "documentation":"If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
The environment variables to pass to a container.
" - } - }, - "documentation":"Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
" - }, - "ContainerDefinitions":{ - "type":"list", - "member":{"shape":"ContainerDefinition"} - }, - "ContainerInstance":{ - "type":"structure", - "members":{ - "containerInstanceArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.
The Amazon EC2 instance ID of the container instance.
" - }, - "remainingResources":{ - "shape":"Resources", - "documentation":"The remaining resources of the container instance that are available for new tasks.
" - }, - "registeredResources":{ - "shape":"Resources", - "documentation":"The registered resources on the container instance that are in use by current tasks.
" - }, - "status":{ - "shape":"String", - "documentation":"The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.
This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false, and instances without a connected agent cannot accept placement request.
An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
" - }, - "ContainerInstances":{ - "type":"list", - "member":{"shape":"ContainerInstance"} - }, - "ContainerOverride":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the container that receives the override.
" - }, - "command":{ - "shape":"StringList", - "documentation":"The command to send to the container that receives the override.
" - } - } - }, - "ContainerOverrides":{ - "type":"list", - "member":{"shape":"ContainerOverride"} - }, - "Containers":{ - "type":"list", - "member":{"shape":"Container"} - }, - "CreateClusterRequest":{ - "type":"structure", - "members":{ - "clusterName":{ - "shape":"String", - "documentation":"The name of your cluster. If you do not specify a name for your cluster, you will create a cluster named default.
The full description of your new cluster.
" - } - } - }, - "DeleteClusterRequest":{ - "type":"structure", - "required":["cluster"], - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The cluster you want to delete.
" - } - } - }, - "DeleteClusterResponse":{ - "type":"structure", - "members":{ - "cluster":{ - "shape":"Cluster", - "documentation":"The full description of the deleted cluster.
" - } - } - }, - "DeregisterContainerInstanceRequest":{ - "type":"structure", - "required":["containerInstance"], - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.
" - }, - "containerInstance":{ - "shape":"String", - "documentation":"The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.
Force the deregistration of the container instance. You can use the force parameter if you have several tasks running on a container instance and you don't want to run StopTask for each task before deregistering the container instance.
The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to deregister.
The full description of the deregistered task.
" - } - } - }, - "DescribeClustersRequest":{ - "type":"structure", - "members":{ - "clusters":{ - "shape":"StringList", - "documentation":"A space-separated list of cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
" - } - } - }, - "DescribeClustersResponse":{ - "type":"structure", - "members":{ - "clusters":{ - "shape":"Clusters", - "documentation":"The list of clusters.
" - }, - "failures":{"shape":"Failures"} - } - }, - "DescribeContainerInstancesRequest":{ - "type":"structure", - "required":["containerInstances"], - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to describe. If you do not specify a cluster, the default cluster is assumed.
" - }, - "containerInstances":{ - "shape":"StringList", - "documentation":"A space-separated list of container instance UUIDs or full Amazon Resource Name (ARN) entries.
" - } - } - }, - "DescribeContainerInstancesResponse":{ - "type":"structure", - "members":{ - "containerInstances":{ - "shape":"ContainerInstances", - "documentation":"The list of container instances.
" - }, - "failures":{"shape":"Failures"} - } - }, - "DescribeTaskDefinitionRequest":{ - "type":"structure", - "required":["taskDefinition"], - "members":{ - "taskDefinition":{ - "shape":"String", - "documentation":"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to describe.
The full task definition description.
" - } - } - }, - "DescribeTasksRequest":{ - "type":"structure", - "required":["tasks"], - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.
" - }, - "tasks":{ - "shape":"StringList", - "documentation":"A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries.
" - } - } - }, - "DescribeTasksResponse":{ - "type":"structure", - "members":{ - "tasks":{ - "shape":"Tasks", - "documentation":"The list of tasks.
" - }, - "failures":{"shape":"Failures"} - } - }, - "DiscoverPollEndpointRequest":{ - "type":"structure", - "members":{ - "containerInstance":{ - "shape":"String", - "documentation":"The container instance UUID or full Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.
The endpoint for the Amazon ECS agent to poll.
" - } - } - }, - "Double":{"type":"double"}, - "EnvironmentVariables":{ - "type":"list", - "member":{"shape":"KeyValuePair"} - }, - "Failure":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the failed resource.
" - }, - "reason":{ - "shape":"String", - "documentation":"The reason for the failure.
" - } - } - }, - "Failures":{ - "type":"list", - "member":{"shape":"Failure"} - }, - "Integer":{"type":"integer"}, - "KeyValuePair":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the key value pair.
" - }, - "value":{ - "shape":"String", - "documentation":"The value of the key value pair.
" - } - } - }, - "ListClustersRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"String", - "documentation":"The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
" - }, - "nextToken":{ - "shape":"String", - "documentation":"The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to list. If you do not specify a cluster, the default cluster is assumed..
" - }, - "nextToken":{ - "shape":"String", - "documentation":"The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
The list of container instance full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.
" - }, - "nextToken":{ - "shape":"String", - "documentation":"The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The name of the family that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to definitions that belong to that family.
The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefintions request.
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..
" - }, - "containerInstance":{ - "shape":"String", - "documentation":"The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.
The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.
The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The list of task Amazon Resource Name (ARN) entries for the ListTasks request.
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The IP address that the container is bound to on the container instance.
" - }, - "containerPort":{ - "shape":"BoxedInteger", - "documentation":"The port number on the container that should be used with the network binding.
" - }, - "hostPort":{ - "shape":"BoxedInteger", - "documentation":"The port number on the host that should be used with the network binding.
" - } - } - }, - "NetworkBindings":{ - "type":"list", - "member":{"shape":"NetworkBinding"} - }, - "PortMapping":{ - "type":"structure", - "members":{ - "containerPort":{ - "shape":"Integer", - "documentation":"The port number on the container that should be used with the port mapping.
" - }, - "hostPort":{ - "shape":"Integer", - "documentation":"The port number on the host that should be used with the port mapping.
" - } - }, - "documentation":"Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
" - }, - "PortMappingList":{ - "type":"list", - "member":{"shape":"PortMapping"} - }, - "RegisterContainerInstanceRequest":{ - "type":"structure", - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..
" - }, - "instanceIdentityDocument":{"shape":"String"}, - "instanceIdentityDocumentSignature":{"shape":"String"}, - "totalResources":{"shape":"Resources"} - } - }, - "RegisterContainerInstanceResponse":{ - "type":"structure", - "members":{ - "containerInstance":{"shape":"ContainerInstance"} - } - }, - "RegisterTaskDefinitionRequest":{ - "type":"structure", - "required":[ - "family", - "containerDefinitions" - ], - "members":{ - "family":{ - "shape":"String", - "documentation":"You can specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition.
A list of container definitions in JSON format that describe the different containers that make up your task.
" - } - } - }, - "RegisterTaskDefinitionResponse":{ - "type":"structure", - "members":{ - "taskDefinition":{"shape":"TaskDefinition"} - } - }, - "Resource":{ - "type":"structure", - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource.
The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
When the integerValue type is set, the value of the resource must be an integer.
When the stringSetValue type is set, the value of the resource must be a string type.
Describes the resources available for a container instance.
" - }, - "Resources":{ - "type":"list", - "member":{"shape":"Resource"} - }, - "RunTaskRequest":{ - "type":"structure", - "required":["taskDefinition"], - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..
" - }, - "taskDefinition":{ - "shape":"String", - "documentation":"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run.
The number of instances of the specified task that you would like to place on your cluster.
" - } - } - }, - "RunTaskResponse":{ - "type":"structure", - "members":{ - "tasks":{ - "shape":"Tasks", - "documentation":"A full description of the tasks that were run. Each task that was successfully placed on your cluster will be described here.
" - }, - "failures":{ - "shape":"Failures", - "documentation":"Any failed tasks from your RunTask action are listed here.
These errors are usually caused by a server-side issue.
" - }, - "StartTaskRequest":{ - "type":"structure", - "required":[ - "taskDefinition", - "containerInstances" - ], - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..
" - }, - "taskDefinition":{ - "shape":"String", - "documentation":"The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.
The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
" - } - } - }, - "StartTaskResponse":{ - "type":"structure", - "members":{ - "tasks":{ - "shape":"Tasks", - "documentation":"A full description of the tasks that were started. Each task that was successfully placed on your container instances will be described here.
" - }, - "failures":{ - "shape":"Failures", - "documentation":"Any failed tasks from your StartTask action are listed here.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to stop. If you do not specify a cluster, the default cluster is assumed..
" - }, - "task":{ - "shape":"String", - "documentation":"The task UUIDs or full Amazon Resource Name (ARN) entry of the task you would like to stop.
" - } - } - }, - "StopTaskResponse":{ - "type":"structure", - "members":{ - "task":{"shape":"Task"} - } - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "SubmitContainerStateChangeRequest":{ - "type":"structure", - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
" - }, - "task":{ - "shape":"String", - "documentation":"The task UUID or full Amazon Resource Name (ARN) of the task that hosts the container.
" - }, - "containerName":{ - "shape":"String", - "documentation":"The name of the container.
" - }, - "status":{ - "shape":"String", - "documentation":"The status of the state change request.
" - }, - "exitCode":{ - "shape":"BoxedInteger", - "documentation":"The exit code returned for the state change request.
" - }, - "reason":{ - "shape":"String", - "documentation":"The reason for the state change request.
" - }, - "networkBindings":{ - "shape":"NetworkBindings", - "documentation":"The network bindings of the container.
" - } - } - }, - "SubmitContainerStateChangeResponse":{ - "type":"structure", - "members":{ - "acknowledgment":{ - "shape":"String", - "documentation":"Acknowledgement of the state change.
" - } - } - }, - "SubmitTaskStateChangeRequest":{ - "type":"structure", - "members":{ - "cluster":{ - "shape":"String", - "documentation":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
" - }, - "task":{ - "shape":"String", - "documentation":"The task UUID or full Amazon Resource Name (ARN) of the task in the state change request.
" - }, - "status":{ - "shape":"String", - "documentation":"The status of the state change request.
" - }, - "reason":{ - "shape":"String", - "documentation":"The reason for the state change request.
" - } - } - }, - "SubmitTaskStateChangeResponse":{ - "type":"structure", - "members":{ - "acknowledgment":{ - "shape":"String", - "documentation":"Acknowledgement of the state change.
" - } - } - }, - "Task":{ - "type":"structure", - "members":{ - "taskArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the task.
" - }, - "clusterArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
" - }, - "taskDefinitionArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the of the task definition that creates the task.
" - }, - "containerInstanceArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the container instances that host the task.
" - }, - "overrides":{ - "shape":"TaskOverride", - "documentation":"One or more container overrides.
" - }, - "lastStatus":{ - "shape":"String", - "documentation":"The last known status of the task.
" - }, - "desiredStatus":{ - "shape":"String", - "documentation":"The desired status of the task.
" - }, - "containers":{ - "shape":"Containers", - "documentation":"The containers associated with the task.
" - } - } - }, - "TaskDefinition":{ - "type":"structure", - "members":{ - "taskDefinitionArn":{ - "shape":"String", - "documentation":"The full Amazon Resource Name (ARN) of the of the task definition.
" - }, - "containerDefinitions":{ - "shape":"ContainerDefinitions", - "documentation":"A list of container definitions in JSON format that describe the different containers that make up your task.
" - }, - "family":{ - "shape":"String", - "documentation":"The family of your task definition. You can think of the family as the name of your task definition.
The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1, and each time you register a task definition in the same family, the revision value increases by one.
One or more container overrides to send when running a task.
" - } - } - }, - "Tasks":{ - "type":"list", - "member":{"shape":"Task"} - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/elasticache/2014-09-30.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/elasticache/2014-09-30.normal.json deleted file mode 100644 index ca9a335164..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/elasticache/2014-09-30.normal.json +++ /dev/null @@ -1,5049 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-09-30", - "endpointPrefix":"elasticache", - "serviceFullName":"Amazon ElastiCache", - "signatureVersion":"v4", - "xmlNamespace":"http://elasticache.amazonaws.com/doc/2014-09-30/", - "protocol":"query" - }, - "documentation":"Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
", - "operations":{ - "AuthorizeCacheSecurityGroupIngress":{ - "name":"AuthorizeCacheSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AuthorizeCacheSecurityGroupIngressMessage", - "documentation":"Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
" - }, - "output":{ - "shape":"AuthorizeCacheSecurityGroupIngressResult", - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"InvalidCacheSecurityGroupStateFault", - "error":{ - "code":"InvalidCacheSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache security group does not allow deletion.
" - }, - { - "shape":"AuthorizationAlreadyExistsFault", - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon EC2 security group is already authorized for the specified cache security group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
" - }, - "CopySnapshot":{ - "name":"CopySnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopySnapshotMessage", - "documentation":"Represents the input of a CopySnapshotMessage operation.
" - }, - "output":{ - "shape":"CopySnapshotResult", - "wrapper":true, - "documentation":"Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
", - "resultWrapper":"CopySnapshotResult" - }, - "errors":[ - { - "shape":"SnapshotAlreadyExistsFault", - "error":{ - "code":"SnapshotAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a snapshot with the given name.
" - }, - { - "shape":"SnapshotNotFoundFault", - "error":{ - "code":"SnapshotNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested snapshot name does not refer to an existing snapshot.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of snapshots.
" - }, - { - "shape":"InvalidSnapshotStateFault", - "error":{ - "code":"InvalidSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the snapshot does not allow the requested action to occur.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The CopySnapshot operation makes a copy of an existing snapshot.
" - }, - "CreateCacheCluster":{ - "name":"CreateCacheCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateCacheClusterMessage", - "documentation":"Represents the input of a CreateCacheCluster operation.
" - }, - "output":{ - "shape":"CreateCacheClusterResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific cache cluster.
", - "resultWrapper":"CreateCacheClusterResult" - }, - "errors":[ - { - "shape":"ReplicationGroupNotFoundFault", - "error":{ - "code":"ReplicationGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group does not exist.
" - }, - { - "shape":"InvalidReplicationGroupStateFault", - "error":{ - "code":"InvalidReplicationGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested replication group is not in the available state.
" - }, - { - "shape":"CacheClusterAlreadyExistsFault", - "error":{ - "code":"CacheClusterAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a cache cluster with the given identifier.
" - }, - { - "shape":"InsufficientCacheClusterCapacityFault", - "error":{ - "code":"InsufficientCacheClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node type is not available in the specified Availability Zone.
" - }, - { - "shape":"CacheSecurityGroupNotFoundFault", - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"CacheSubnetGroupNotFoundFault", - "error":{ - "code":"CacheSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group name does not refer to an existing cache subnet group.
" - }, - { - "shape":"ClusterQuotaForCustomerExceededFault", - "error":{ - "code":"ClusterQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache clusters per customer.
" - }, - { - "shape":"NodeQuotaForClusterExceededFault", - "error":{ - "code":"NodeQuotaForClusterExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.
" - }, - { - "shape":"NodeQuotaForCustomerExceededFault", - "error":{ - "code":"NodeQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
" - }, - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC network is in an invalid state.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The CreateCacheCluster operation creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
" - }, - "CreateCacheParameterGroup":{ - "name":"CreateCacheParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateCacheParameterGroupMessage", - "documentation":"Represents the input of a CreateCacheParameterGroup operation.
" - }, - "output":{ - "shape":"CreateCacheParameterGroupResult", - "wrapper":true, - "documentation":"Represents the output of a CreateCacheParameterGroup operation.
", - "resultWrapper":"CreateCacheParameterGroupResult" - }, - "errors":[ - { - "shape":"CacheParameterGroupQuotaExceededFault", - "error":{ - "code":"CacheParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of cache security groups.
" - }, - { - "shape":"CacheParameterGroupAlreadyExistsFault", - "error":{ - "code":"CacheParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A cache parameter group with the requested name already exists.
" - }, - { - "shape":"InvalidCacheParameterGroupStateFault", - "error":{ - "code":"InvalidCacheParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache parameter group does not allow the requested action to occur.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The CreateCacheParameterGroup operation creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.
" - }, - "CreateCacheSecurityGroup":{ - "name":"CreateCacheSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateCacheSecurityGroupMessage", - "documentation":"Represents the input of a CreateCacheSecurityGroup operation.
" - }, - "output":{ - "shape":"CreateCacheSecurityGroupResult", - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
A cache security group with the specified name already exists.
" - }, - { - "shape":"CacheSecurityGroupQuotaExceededFault", - "error":{ - "code":"QuotaExceeded.CacheSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache security groups.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The CreateCacheSecurityGroup operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.
Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
" - }, - "CreateCacheSubnetGroup":{ - "name":"CreateCacheSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateCacheSubnetGroupMessage", - "documentation":"Represents the input of a CreateCacheSubnetGroup operation.
" - }, - "output":{ - "shape":"CreateCacheSubnetGroupResult", - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
The requested cache subnet group name is already in use by an existing cache subnet group.
" - }, - { - "shape":"CacheSubnetGroupQuotaExceededFault", - "error":{ - "code":"CacheSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache subnet groups.
" - }, - { - "shape":"CacheSubnetQuotaExceededFault", - "error":{ - "code":"CacheSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An invalid subnet identifier was specified.
" - } - ], - "documentation":"The CreateCacheSubnetGroup operation creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
" - }, - "CreateReplicationGroup":{ - "name":"CreateReplicationGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateReplicationGroupMessage", - "documentation":"Represents the input of a CreateReplicationGroup operation.
" - }, - "output":{ - "shape":"CreateReplicationGroupResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific replication group.
", - "resultWrapper":"CreateReplicationGroupResult" - }, - "errors":[ - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"InvalidCacheClusterStateFault", - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - { - "shape":"ReplicationGroupAlreadyExistsFault", - "error":{ - "code":"ReplicationGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group already exists.
" - }, - { - "shape":"InsufficientCacheClusterCapacityFault", - "error":{ - "code":"InsufficientCacheClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node type is not available in the specified Availability Zone.
" - }, - { - "shape":"CacheSecurityGroupNotFoundFault", - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"CacheSubnetGroupNotFoundFault", - "error":{ - "code":"CacheSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group name does not refer to an existing cache subnet group.
" - }, - { - "shape":"ClusterQuotaForCustomerExceededFault", - "error":{ - "code":"ClusterQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache clusters per customer.
" - }, - { - "shape":"NodeQuotaForClusterExceededFault", - "error":{ - "code":"NodeQuotaForClusterExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.
" - }, - { - "shape":"NodeQuotaForCustomerExceededFault", - "error":{ - "code":"NodeQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
" - }, - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC network is in an invalid state.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.
When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.
Note: This action is valid only for Redis.
" - }, - "CreateSnapshot":{ - "name":"CreateSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateSnapshotMessage", - "documentation":"Represents the input of a CreateSnapshot operation.
" - }, - "output":{ - "shape":"CreateSnapshotResult", - "wrapper":true, - "documentation":"Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
", - "resultWrapper":"CreateSnapshotResult" - }, - "errors":[ - { - "shape":"SnapshotAlreadyExistsFault", - "error":{ - "code":"SnapshotAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a snapshot with the given name.
" - }, - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"InvalidCacheClusterStateFault", - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of snapshots.
" - }, - { - "shape":"SnapshotFeatureNotSupportedFault", - "error":{ - "code":"SnapshotFeatureNotSupportedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - } - ], - "documentation":"The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.
" - }, - "DeleteCacheCluster":{ - "name":"DeleteCacheCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteCacheClusterMessage", - "documentation":"Represents the input of a DeleteCacheCluster operation.
" - }, - "output":{ - "shape":"DeleteCacheClusterResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific cache cluster.
", - "resultWrapper":"DeleteCacheClusterResult" - }, - "errors":[ - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"InvalidCacheClusterStateFault", - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - { - "shape":"SnapshotAlreadyExistsFault", - "error":{ - "code":"SnapshotAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a snapshot with the given name.
" - }, - { - "shape":"SnapshotFeatureNotSupportedFault", - "error":{ - "code":"SnapshotFeatureNotSupportedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of snapshots.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.
This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has automatic failover mode enabled.
" - }, - "DeleteCacheParameterGroup":{ - "name":"DeleteCacheParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteCacheParameterGroupMessage", - "documentation":"Represents the input of a DeleteCacheParameterGroup operation.
" - }, - "errors":[ - { - "shape":"InvalidCacheParameterGroupStateFault", - "error":{ - "code":"InvalidCacheParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache parameter group does not allow the requested action to occur.
" - }, - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
" - }, - "DeleteCacheSecurityGroup":{ - "name":"DeleteCacheSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteCacheSecurityGroupMessage", - "documentation":"Represents the input of a DeleteCacheSecurityGroup operation.
" - }, - "errors":[ - { - "shape":"InvalidCacheSecurityGroupStateFault", - "error":{ - "code":"InvalidCacheSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache security group does not allow deletion.
" - }, - { - "shape":"CacheSecurityGroupNotFoundFault", - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DeleteCacheSecurityGroup operation deletes a cache security group.
" - }, - "DeleteCacheSubnetGroup":{ - "name":"DeleteCacheSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteCacheSubnetGroupMessage", - "documentation":"Represents the input of a DeleteCacheSubnetGroup operation.
" - }, - "errors":[ - { - "shape":"CacheSubnetGroupInUse", - "error":{ - "code":"CacheSubnetGroupInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group is currently in use.
" - }, - { - "shape":"CacheSubnetGroupNotFoundFault", - "error":{ - "code":"CacheSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group name does not refer to an existing cache subnet group.
" - } - ], - "documentation":"The DeleteCacheSubnetGroup operation deletes a cache subnet group.
" - }, - "DeleteReplicationGroup":{ - "name":"DeleteReplicationGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteReplicationGroupMessage", - "documentation":"Represents the input of a DeleteReplicationGroup operation.
" - }, - "output":{ - "shape":"DeleteReplicationGroupResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific replication group.
", - "resultWrapper":"DeleteReplicationGroupResult" - }, - "errors":[ - { - "shape":"ReplicationGroupNotFoundFault", - "error":{ - "code":"ReplicationGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group does not exist.
" - }, - { - "shape":"InvalidReplicationGroupStateFault", - "error":{ - "code":"InvalidReplicationGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested replication group is not in the available state.
" - }, - { - "shape":"SnapshotAlreadyExistsFault", - "error":{ - "code":"SnapshotAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a snapshot with the given name.
" - }, - { - "shape":"SnapshotFeatureNotSupportedFault", - "error":{ - "code":"SnapshotFeatureNotSupportedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of snapshots.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DeleteReplicationGroup operation deletes an existing cluster. By default, this operation deletes the entire cluster, including the primary node group and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary node group.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
" - }, - "DeleteSnapshot":{ - "name":"DeleteSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteSnapshotMessage", - "documentation":"Represents the input of a DeleteSnapshot operation.
" - }, - "output":{ - "shape":"DeleteSnapshotResult", - "wrapper":true, - "documentation":"Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
", - "resultWrapper":"DeleteSnapshotResult" - }, - "errors":[ - { - "shape":"SnapshotNotFoundFault", - "error":{ - "code":"SnapshotNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested snapshot name does not refer to an existing snapshot.
" - }, - { - "shape":"InvalidSnapshotStateFault", - "error":{ - "code":"InvalidSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the snapshot does not allow the requested action to occur.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DeleteSnapshot operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
" - }, - "DescribeCacheClusters":{ - "name":"DescribeCacheClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeCacheClustersMessage", - "documentation":"Represents the input of a DescribeCacheClusters operation.
" - }, - "output":{ - "shape":"CacheClusterMessage", - "documentation":"Represents the output of a DescribeCacheClusters operation.
", - "resultWrapper":"DescribeCacheClustersResult" - }, - "errors":[ - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
" - }, - "DescribeCacheEngineVersions":{ - "name":"DescribeCacheEngineVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeCacheEngineVersionsMessage", - "documentation":"Represents the input of a DescribeCacheEngineVersions operation.
" - }, - "output":{ - "shape":"CacheEngineVersionMessage", - "documentation":"Represents the output of a DescribeCacheEngineVersions operation.
", - "resultWrapper":"DescribeCacheEngineVersionsResult" - }, - "documentation":"The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.
" - }, - "DescribeCacheParameterGroups":{ - "name":"DescribeCacheParameterGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeCacheParameterGroupsMessage", - "documentation":"Represents the input of a DescribeCacheParameterGroups operation.
" - }, - "output":{ - "shape":"CacheParameterGroupsMessage", - "documentation":"Represents the output of a DescribeCacheParameterGroups operation.
", - "resultWrapper":"DescribeCacheParameterGroupsResult" - }, - "errors":[ - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
" - }, - "DescribeCacheParameters":{ - "name":"DescribeCacheParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeCacheParametersMessage", - "documentation":"Represents the input of a DescribeCacheParameters operation.
" - }, - "output":{ - "shape":"CacheParameterGroupDetails", - "documentation":"Represents the output of a DescribeCacheParameters operation.
", - "resultWrapper":"DescribeCacheParametersResult" - }, - "errors":[ - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.
" - }, - "DescribeCacheSecurityGroups":{ - "name":"DescribeCacheSecurityGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeCacheSecurityGroupsMessage", - "documentation":"Represents the input of a DescribeCacheSecurityGroups operation.
" - }, - "output":{ - "shape":"CacheSecurityGroupMessage", - "documentation":"Represents the output of a DescribeCacheSecurityGroups operation.
", - "resultWrapper":"DescribeCacheSecurityGroupsResult" - }, - "errors":[ - { - "shape":"CacheSecurityGroupNotFoundFault", - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
" - }, - "DescribeCacheSubnetGroups":{ - "name":"DescribeCacheSubnetGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeCacheSubnetGroupsMessage", - "documentation":"Represents the input of a DescribeCacheSubnetGroups operation.
" - }, - "output":{ - "shape":"CacheSubnetGroupMessage", - "documentation":"Represents the output of a DescribeCacheSubnetGroups operation.
", - "resultWrapper":"DescribeCacheSubnetGroupsResult" - }, - "errors":[ - { - "shape":"CacheSubnetGroupNotFoundFault", - "error":{ - "code":"CacheSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group name does not refer to an existing cache subnet group.
" - } - ], - "documentation":"The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
" - }, - "DescribeEngineDefaultParameters":{ - "name":"DescribeEngineDefaultParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEngineDefaultParametersMessage", - "documentation":"Represents the input of a DescribeEngineDefaultParameters operation.
" - }, - "output":{ - "shape":"DescribeEngineDefaultParametersResult", - "wrapper":true, - "documentation":"Represents the output of a DescribeEngineDefaultParameters operation.
", - "resultWrapper":"DescribeEngineDefaultParametersResult" - }, - "errors":[ - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.
" - }, - "DescribeEvents":{ - "name":"DescribeEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventsMessage", - "documentation":"Represents the input of a DescribeEvents operation.
" - }, - "output":{ - "shape":"EventsMessage", - "documentation":"Represents the output of a DescribeEvents operation.
", - "resultWrapper":"DescribeEventsResult" - }, - "errors":[ - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
" - }, - "DescribeReplicationGroups":{ - "name":"DescribeReplicationGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReplicationGroupsMessage", - "documentation":"Represents the input of a DescribeReplicationGroups operation.
" - }, - "output":{ - "shape":"ReplicationGroupMessage", - "documentation":"Represents the output of a DescribeReplicationGroups operation.
", - "resultWrapper":"DescribeReplicationGroupsResult" - }, - "errors":[ - { - "shape":"ReplicationGroupNotFoundFault", - "error":{ - "code":"ReplicationGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
" - }, - "DescribeReservedCacheNodes":{ - "name":"DescribeReservedCacheNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedCacheNodesMessage", - "documentation":"Represents the input of a DescribeReservedCacheNodes operation.
" - }, - "output":{ - "shape":"ReservedCacheNodeMessage", - "documentation":"Represents the output of a DescribeReservedCacheNodes operation.
", - "resultWrapper":"DescribeReservedCacheNodesResult" - }, - "errors":[ - { - "shape":"ReservedCacheNodeNotFoundFault", - "error":{ - "code":"ReservedCacheNodeNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested reserved cache node was not found.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.
" - }, - "DescribeReservedCacheNodesOfferings":{ - "name":"DescribeReservedCacheNodesOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedCacheNodesOfferingsMessage", - "documentation":"Represents the input of a DescribeReservedCacheNodesOfferings operation.
" - }, - "output":{ - "shape":"ReservedCacheNodesOfferingMessage", - "documentation":"Represents the output of a DescribeReservedCacheNodesOfferings operation.
", - "resultWrapper":"DescribeReservedCacheNodesOfferingsResult" - }, - "errors":[ - { - "shape":"ReservedCacheNodesOfferingNotFoundFault", - "error":{ - "code":"ReservedCacheNodesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node offering does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.
" - }, - "DescribeSnapshots":{ - "name":"DescribeSnapshots", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeSnapshotsMessage", - "documentation":"Represents the input of a DescribeSnapshotsMessage operation.
" - }, - "output":{ - "shape":"DescribeSnapshotsListMessage", - "documentation":"Represents the output of a DescribeSnapshots operation.
", - "resultWrapper":"DescribeSnapshotsResult" - }, - "errors":[ - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"SnapshotNotFoundFault", - "error":{ - "code":"SnapshotNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested snapshot name does not refer to an existing snapshot.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
" - }, - "ModifyCacheCluster":{ - "name":"ModifyCacheCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyCacheClusterMessage", - "documentation":"Represents the input of a ModifyCacheCluster operation.
" - }, - "output":{ - "shape":"ModifyCacheClusterResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific cache cluster.
", - "resultWrapper":"ModifyCacheClusterResult" - }, - "errors":[ - { - "shape":"InvalidCacheClusterStateFault", - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - { - "shape":"InvalidCacheSecurityGroupStateFault", - "error":{ - "code":"InvalidCacheSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache security group does not allow deletion.
" - }, - { - "shape":"InsufficientCacheClusterCapacityFault", - "error":{ - "code":"InsufficientCacheClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node type is not available in the specified Availability Zone.
" - }, - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"NodeQuotaForClusterExceededFault", - "error":{ - "code":"NodeQuotaForClusterExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.
" - }, - { - "shape":"NodeQuotaForCustomerExceededFault", - "error":{ - "code":"NodeQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
" - }, - { - "shape":"CacheSecurityGroupNotFoundFault", - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC network is in an invalid state.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
" - }, - "ModifyCacheParameterGroup":{ - "name":"ModifyCacheParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyCacheParameterGroupMessage", - "documentation":"Represents the input of a ModifyCacheParameterGroup operation.
" - }, - "output":{ - "shape":"CacheParameterGroupNameMessage", - "documentation":"Represents the output of one of the following operations:
The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidCacheParameterGroupStateFault", - "error":{ - "code":"InvalidCacheParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache parameter group does not allow the requested action to occur.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
" - }, - "ModifyCacheSubnetGroup":{ - "name":"ModifyCacheSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyCacheSubnetGroupMessage", - "documentation":"Represents the input of a ModifyCacheSubnetGroup operation.
" - }, - "output":{ - "shape":"ModifyCacheSubnetGroupResult", - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
The requested cache subnet group name does not refer to an existing cache subnet group.
" - }, - { - "shape":"CacheSubnetQuotaExceededFault", - "error":{ - "code":"CacheSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
" - }, - { - "shape":"SubnetInUse", - "error":{ - "code":"SubnetInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is being used by another cache subnet group.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An invalid subnet identifier was specified.
" - } - ], - "documentation":"The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.
" - }, - "ModifyReplicationGroup":{ - "name":"ModifyReplicationGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyReplicationGroupMessage", - "documentation":"Represents the input of a ModifyReplicationGroups operation.
" - }, - "output":{ - "shape":"ModifyReplicationGroupResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific replication group.
", - "resultWrapper":"ModifyReplicationGroupResult" - }, - "errors":[ - { - "shape":"ReplicationGroupNotFoundFault", - "error":{ - "code":"ReplicationGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group does not exist.
" - }, - { - "shape":"InvalidReplicationGroupStateFault", - "error":{ - "code":"InvalidReplicationGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested replication group is not in the available state.
" - }, - { - "shape":"InvalidCacheClusterStateFault", - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - { - "shape":"InvalidCacheSecurityGroupStateFault", - "error":{ - "code":"InvalidCacheSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache security group does not allow deletion.
" - }, - { - "shape":"InsufficientCacheClusterCapacityFault", - "error":{ - "code":"InsufficientCacheClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node type is not available in the specified Availability Zone.
" - }, - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - { - "shape":"NodeQuotaForClusterExceededFault", - "error":{ - "code":"NodeQuotaForClusterExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.
" - }, - { - "shape":"NodeQuotaForCustomerExceededFault", - "error":{ - "code":"NodeQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
" - }, - { - "shape":"CacheSecurityGroupNotFoundFault", - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC network is in an invalid state.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The ModifyReplicationGroup operation modifies the settings for a replication group.
" - }, - "PurchaseReservedCacheNodesOffering":{ - "name":"PurchaseReservedCacheNodesOffering", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PurchaseReservedCacheNodesOfferingMessage", - "documentation":"Represents the input of a PurchaseReservedCacheNodesOffering operation.
" - }, - "output":{ - "shape":"PurchaseReservedCacheNodesOfferingResult", - "wrapper":true, - "documentation":"Represents the output of a PurchaseReservedCacheNodesOffering operation.
", - "resultWrapper":"PurchaseReservedCacheNodesOfferingResult" - }, - "errors":[ - { - "shape":"ReservedCacheNodesOfferingNotFoundFault", - "error":{ - "code":"ReservedCacheNodesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node offering does not exist.
" - }, - { - "shape":"ReservedCacheNodeAlreadyExistsFault", - "error":{ - "code":"ReservedCacheNodeAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a reservation with the given identifier.
" - }, - { - "shape":"ReservedCacheNodeQuotaExceededFault", - "error":{ - "code":"ReservedCacheNodeQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the user's cache node quota.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.
" - }, - "RebootCacheCluster":{ - "name":"RebootCacheCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RebootCacheClusterMessage", - "documentation":"Represents the input of a RebootCacheCluster operation.
" - }, - "output":{ - "shape":"RebootCacheClusterResult", - "wrapper":true, - "documentation":"Contains all of the attributes of a specific cache cluster.
", - "resultWrapper":"RebootCacheClusterResult" - }, - "errors":[ - { - "shape":"InvalidCacheClusterStateFault", - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - { - "shape":"CacheClusterNotFoundFault", - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - } - ], - "documentation":"The RebootCacheCluster operation reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cache cluster event is created.
" - }, - "ResetCacheParameterGroup":{ - "name":"ResetCacheParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ResetCacheParameterGroupMessage", - "documentation":"Represents the input of a ResetCacheParameterGroup operation.
" - }, - "output":{ - "shape":"CacheParameterGroupNameMessage", - "documentation":"Represents the output of one of the following operations:
The current state of the cache parameter group does not allow the requested action to occur.
" - }, - { - "shape":"CacheParameterGroupNotFoundFault", - "error":{ - "code":"CacheParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
" - }, - "RevokeCacheSecurityGroupIngress":{ - "name":"RevokeCacheSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RevokeCacheSecurityGroupIngressMessage", - "documentation":"Represents the input of a RevokeCacheSecurityGroupIngress operation.
" - }, - "output":{ - "shape":"RevokeCacheSecurityGroupIngressResult", - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
The requested cache security group name does not refer to an existing cache security group.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon EC2 security group is not authorized for the specified cache security group.
" - }, - { - "shape":"InvalidCacheSecurityGroupStateFault", - "error":{ - "code":"InvalidCacheSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache security group does not allow deletion.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidParameterCombinationException", - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - } - ], - "documentation":"The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
" - } - }, - "shapes":{ - "AZMode":{ - "type":"string", - "enum":[ - "single-az", - "cross-az" - ] - }, - "AuthorizationAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon EC2 security group is already authorized for the specified cache security group.
" - }, - "AuthorizationNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon EC2 security group is not authorized for the specified cache security group.
" - }, - "AuthorizeCacheSecurityGroupIngressMessage":{ - "type":"structure", - "required":[ - "CacheSecurityGroupName", - "EC2SecurityGroupName", - "EC2SecurityGroupOwnerId" - ], - "members":{ - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"The cache security group which will allow network ingress.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"The Amazon EC2 security group to be authorized for ingress to the cache security group.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
" - } - }, - "documentation":"Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
" - }, - "AutomaticFailoverStatus":{ - "type":"string", - "enum":[ - "enabled", - "disabled", - "enabling", - "disabling" - ] - }, - "AvailabilityZone":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the Availability Zone.
" - } - }, - "wrapper":true, - "documentation":"Describes an Availability Zone in which the cache cluster is launched.
" - }, - "AvailabilityZonesList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"AvailabilityZone" - } - }, - "AwsQueryErrorMessage":{"type":"string"}, - "Boolean":{"type":"boolean"}, - "BooleanOptional":{"type":"boolean"}, - "CacheCluster":{ - "type":"structure", - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
" - }, - "ConfigurationEndpoint":{"shape":"Endpoint"}, - "ClientDownloadLandingPage":{ - "shape":"String", - "documentation":"The URL of the web page where you can download the latest ElastiCache client library.
" - }, - "CacheNodeType":{ - "shape":"String", - "documentation":"The name of the compute and memory capacity node type for the cache cluster.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The name of the cache engine (memcached or redis) to be used for this cache cluster.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version of the cache engine version that is used in this cache cluster.
" - }, - "CacheClusterStatus":{ - "shape":"String", - "documentation":"The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
" - }, - "NumCacheNodes":{ - "shape":"IntegerOptional", - "documentation":"The number of cache nodes in the cache cluster.
" - }, - "PreferredAvailabilityZone":{ - "shape":"String", - "documentation":"The name of the Availability Zone in which the cache cluster is located or \"Multiple\" if the cache nodes are located in different Availability Zones.
" - }, - "CacheClusterCreateTime":{ - "shape":"TStamp", - "documentation":"The date and time when the cache cluster was created.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The time range (in UTC) during which weekly system maintenance can occur.
" - }, - "PendingModifiedValues":{"shape":"PendingModifiedValues"}, - "NotificationConfiguration":{"shape":"NotificationConfiguration"}, - "CacheSecurityGroups":{ - "shape":"CacheSecurityGroupMembershipList", - "documentation":"A list of cache security group elements, composed of name and status sub-elements.
" - }, - "CacheParameterGroup":{"shape":"CacheParameterGroupStatus"}, - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cache subnet group associated with the cache cluster.
" - }, - "CacheNodes":{ - "shape":"CacheNodeList", - "documentation":"A list of cache nodes that are members of the cache cluster.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"If true, then minor version patches are applied automatically; if false, then automatic minor version patches are disabled.
A list of VPC Security Groups associated with the cache cluster.
" - }, - "ReplicationGroupId":{ - "shape":"String", - "documentation":"The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
" - }, - "SnapshotRetentionLimit":{ - "shape":"IntegerOptional", - "documentation":"The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
" - }, - "CacheClusterAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheClusterAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a cache cluster with the given identifier.
" - }, - "CacheClusterList":{ - "type":"list", - "member":{ - "shape":"CacheCluster", - "locationName":"CacheCluster" - } - }, - "CacheClusterMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "CacheClusters":{ - "shape":"CacheClusterList", - "documentation":"A list of cache clusters. Each item in the list contains detailed information about one cache cluster.
" - } - }, - "documentation":"Represents the output of a DescribeCacheClusters operation.
" - }, - "CacheClusterNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster ID does not refer to an existing cache cluster.
" - }, - "CacheEngineVersion":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"The name of the cache engine.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version number of the cache engine.
" - }, - "CacheParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the cache parameter group family associated with this cache engine.
" - }, - "CacheEngineDescription":{ - "shape":"String", - "documentation":"The description of the cache engine.
" - }, - "CacheEngineVersionDescription":{ - "shape":"String", - "documentation":"The description of the cache engine version.
" - } - }, - "documentation":"Provides all of the details about a particular cache engine version.
" - }, - "CacheEngineVersionList":{ - "type":"list", - "member":{ - "shape":"CacheEngineVersion", - "locationName":"CacheEngineVersion" - } - }, - "CacheEngineVersionMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "CacheEngineVersions":{ - "shape":"CacheEngineVersionList", - "documentation":"A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
" - } - }, - "documentation":"Represents the output of a DescribeCacheEngineVersions operation.
" - }, - "CacheNode":{ - "type":"structure", - "members":{ - "CacheNodeId":{ - "shape":"String", - "documentation":"The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
" - }, - "CacheNodeStatus":{ - "shape":"String", - "documentation":"The current state of this cache node.
" - }, - "CacheNodeCreateTime":{ - "shape":"TStamp", - "documentation":"The date and time when the cache node was created.
" - }, - "Endpoint":{ - "shape":"Endpoint", - "documentation":"The hostname and IP address for connecting to this cache node.
" - }, - "ParameterGroupStatus":{ - "shape":"String", - "documentation":"The status of the parameter group applied to this cache node.
" - }, - "SourceCacheNodeId":{ - "shape":"String", - "documentation":"The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.
" - }, - "CustomerAvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone where this node was created and now resides.
" - } - }, - "documentation":"Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
" - }, - "CacheNodeIdsList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"CacheNodeId" - } - }, - "CacheNodeList":{ - "type":"list", - "member":{ - "shape":"CacheNode", - "locationName":"CacheNode" - } - }, - "CacheNodeTypeSpecificParameter":{ - "type":"structure", - "members":{ - "ParameterName":{ - "shape":"String", - "documentation":"The name of the parameter.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the parameter.
" - }, - "Source":{ - "shape":"String", - "documentation":"The source of the parameter value.
" - }, - "DataType":{ - "shape":"String", - "documentation":"The valid data type for the parameter.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"The valid range of values for the parameter.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":"Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest cache engine version to which the parameter can apply.
" - }, - "CacheNodeTypeSpecificValues":{ - "shape":"CacheNodeTypeSpecificValueList", - "documentation":"A list of cache node types and their corresponding values for this parameter.
" - } - }, - "documentation":"A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
" - }, - "CacheNodeTypeSpecificParametersList":{ - "type":"list", - "member":{ - "shape":"CacheNodeTypeSpecificParameter", - "locationName":"CacheNodeTypeSpecificParameter" - } - }, - "CacheNodeTypeSpecificValue":{ - "type":"structure", - "members":{ - "CacheNodeType":{ - "shape":"String", - "documentation":"The cache node type for which this value applies.
" - }, - "Value":{ - "shape":"String", - "documentation":"The value for the cache node type.
" - } - }, - "documentation":"A value that applies only to a certain cache node type.
" - }, - "CacheNodeTypeSpecificValueList":{ - "type":"list", - "member":{ - "shape":"CacheNodeTypeSpecificValue", - "locationName":"CacheNodeTypeSpecificValue" - } - }, - "CacheParameterGroup":{ - "type":"structure", - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group.
" - }, - "CacheParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the cache parameter group family that this cache parameter group is compatible with.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description for this cache parameter group.
" - } - }, - "wrapper":true, - "documentation":"Represents the output of a CreateCacheParameterGroup operation.
" - }, - "CacheParameterGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A cache parameter group with the requested name already exists.
" - }, - "CacheParameterGroupDetails":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "Parameters":{ - "shape":"ParametersList", - "documentation":"A list of Parameter instances.
" - }, - "CacheNodeTypeSpecificParameters":{ - "shape":"CacheNodeTypeSpecificParametersList", - "documentation":"A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
" - } - }, - "documentation":"Represents the output of a DescribeCacheParameters operation.
" - }, - "CacheParameterGroupList":{ - "type":"list", - "member":{ - "shape":"CacheParameterGroup", - "locationName":"CacheParameterGroup" - } - }, - "CacheParameterGroupNameMessage":{ - "type":"structure", - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group.
" - } - }, - "documentation":"Represents the output of one of the following operations:
The requested cache parameter group name does not refer to an existing cache parameter group.
" - }, - "CacheParameterGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of cache security groups.
" - }, - "CacheParameterGroupStatus":{ - "type":"structure", - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group.
" - }, - "ParameterApplyStatus":{ - "shape":"String", - "documentation":"The status of parameter updates.
" - }, - "CacheNodeIdsToReboot":{ - "shape":"CacheNodeIdsList", - "documentation":"A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
" - } - }, - "documentation":"The status of the cache parameter group.
" - }, - "CacheParameterGroupsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "CacheParameterGroups":{ - "shape":"CacheParameterGroupList", - "documentation":"A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
" - } - }, - "documentation":"Represents the output of a DescribeCacheParameterGroups operation.
" - }, - "CacheSecurityGroup":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the cache security group owner.
" - }, - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cache security group.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the cache security group.
" - }, - "EC2SecurityGroups":{ - "shape":"EC2SecurityGroupList", - "documentation":"A list of Amazon EC2 security groups that are associated with this cache security group.
" - } - }, - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
A cache security group with the specified name already exists.
" - }, - "CacheSecurityGroupMembership":{ - "type":"structure", - "members":{ - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cache security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
" - } - }, - "documentation":"Represents a cache cluster's status within a particular cache security group.
" - }, - "CacheSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"CacheSecurityGroupMembership", - "locationName":"CacheSecurityGroup" - } - }, - "CacheSecurityGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "CacheSecurityGroups":{ - "shape":"CacheSecurityGroups", - "documentation":"A list of cache security groups. Each element in the list contains detailed information about one group.
" - } - }, - "documentation":"Represents the output of a DescribeCacheSecurityGroups operation.
" - }, - "CacheSecurityGroupNameList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"CacheSecurityGroupName" - } - }, - "CacheSecurityGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache security group name does not refer to an existing cache security group.
" - }, - "CacheSecurityGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"QuotaExceeded.CacheSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache security groups.
" - }, - "CacheSecurityGroups":{ - "type":"list", - "member":{ - "shape":"CacheSecurityGroup", - "locationName":"CacheSecurityGroup" - } - }, - "CacheSubnetGroup":{ - "type":"structure", - "members":{ - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cache subnet group.
" - }, - "CacheSubnetGroupDescription":{ - "shape":"String", - "documentation":"The description of the cache subnet group.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
" - }, - "Subnets":{ - "shape":"SubnetList", - "documentation":"A list of subnets associated with the cache subnet group.
" - } - }, - "wrapper":true, - "documentation":"Represents the output of one of the following operations:
The requested cache subnet group name is already in use by an existing cache subnet group.
" - }, - "CacheSubnetGroupInUse":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheSubnetGroupInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group is currently in use.
" - }, - "CacheSubnetGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "CacheSubnetGroups":{ - "shape":"CacheSubnetGroups", - "documentation":"A list of cache subnet groups. Each element in the list contains detailed information about one group.
" - } - }, - "documentation":"Represents the output of a DescribeCacheSubnetGroups operation.
" - }, - "CacheSubnetGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache subnet group name does not refer to an existing cache subnet group.
" - }, - "CacheSubnetGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache subnet groups.
" - }, - "CacheSubnetGroups":{ - "type":"list", - "member":{ - "shape":"CacheSubnetGroup", - "locationName":"CacheSubnetGroup" - } - }, - "CacheSubnetQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CacheSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
" - }, - "ClusterIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ClusterId" - } - }, - "ClusterQuotaForCustomerExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache clusters per customer.
" - }, - "CopySnapshotMessage":{ - "type":"structure", - "required":[ - "SourceSnapshotName", - "TargetSnapshotName" - ], - "members":{ - "SourceSnapshotName":{ - "shape":"String", - "documentation":"The name of an existing snapshot from which to copy.
" - }, - "TargetSnapshotName":{ - "shape":"String", - "documentation":"A name for the copied snapshot.
" - } - }, - "documentation":"Represents the input of a CopySnapshotMessage operation.
" - }, - "CreateCacheClusterMessage":{ - "type":"structure", - "required":["CacheClusterId"], - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The node group identifier. This parameter is stored as a lowercase string.
Constraints:
The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.
If the specified replication group is Automatic Failover enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note: This parameter is only valid if the Engine parameter is redis.
Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
The EC2 Availability Zone in which the cache cluster will be created.
All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.
Default: System chosen Availability Zone.
" - }, - "PreferredAvailabilityZones":{ - "shape":"PreferredAvailabilityZoneList", - "documentation":"A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
The initial number of cache nodes that the cache cluster will have.
For Memcached, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
For Redis, only single-node cache cluster are supported at this time, so the value for this parameter must be 1.
" - }, - "CacheNodeType":{ - "shape":"String", - "documentation":"The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlargecache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached | redis
The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
" - }, - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
" - }, - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
" - }, - "CacheSecurityGroupNames":{ - "shape":"CacheSecurityGroupNameList", - "documentation":"A list of security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIdsList", - "documentation":"One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
" - }, - "SnapshotArns":{ - "shape":"SnapshotArnsList", - "documentation":"A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.
Note: This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.
Note: This parameter is only valid if the Engine parameter is redis.
The weekly time range (in UTC) during which system maintenance can occur.
Example: sun:05:00-sun:09:00
The port number on which each of the cache nodes will accept connections.
" - }, - "NotificationTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.
Default: true
The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" - }, - "SnapshotWindow":{ - "shape":"String", - "documentation":"The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the Engine parameter is redis.
Represents the input of a CreateCacheCluster operation.
" - }, - "CreateCacheParameterGroupMessage":{ - "type":"structure", - "required":[ - "CacheParameterGroupName", - "CacheParameterGroupFamily", - "Description" - ], - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"A user-specified name for the cache parameter group.
" - }, - "CacheParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the cache parameter group family the cache parameter group can be used with.
Valid values are: memcached1.4 | redis2.6 | redis2.8
A user-specified description for the cache parameter group.
" - } - }, - "documentation":"Represents the input of a CreateCacheParameterGroup operation.
" - }, - "CreateCacheSecurityGroupMessage":{ - "type":"structure", - "required":[ - "CacheSecurityGroupName", - "Description" - ], - "members":{ - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"A name for the cache security group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".
Example: mysecuritygroup
A description for the cache security group.
" - } - }, - "documentation":"Represents the input of a CreateCacheSecurityGroup operation.
" - }, - "CreateCacheSubnetGroupMessage":{ - "type":"structure", - "required":[ - "CacheSubnetGroupName", - "CacheSubnetGroupDescription", - "SubnetIds" - ], - "members":{ - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"A name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
A description for the cache subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"A list of VPC subnet IDs for the cache subnet group.
" - } - }, - "documentation":"Represents the input of a CreateCacheSubnetGroup operation.
" - }, - "CreateReplicationGroupMessage":{ - "type":"structure", - "required":[ - "ReplicationGroupId", - "ReplicationGroupDescription" - ], - "members":{ - "ReplicationGroupId":{ - "shape":"String", - "documentation":"The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A user-created description for the replication group.
" - }, - "PrimaryClusterId":{ - "shape":"String", - "documentation":"The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters is specified.
" - }, - "AutomaticFailoverEnabled":{ - "shape":"BooleanOptional", - "documentation":"Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
If true, automatic failover is enabled for this replication group. If false, automatic failover is disabled for this replication group.
Default: false
" - }, - "NumCacheClusters":{ - "shape":"IntegerOptional", - "documentation":"The number of cache clusters this replication group will initially have.
If AutomaticFailover is enabled, the value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request forrm at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
" - }, - "PreferredCacheClusterAZs":{ - "shape":"AvailabilityZonesList", - "documentation":"A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-east-1a PreferredAvailabilityZones.member.2=us-east-1c PreferredAvailabilityZones.member.3=us-east-1d
" - }, - "CacheNodeType":{ - "shape":"String", - "documentation":"The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlargecache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The name of the cache engine to be used for the cache clusters in this replication group.
Default: redis
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version number of the cach engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
" - }, - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
" - }, - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cache subnet group to be used for the replication group.
" - }, - "CacheSecurityGroupNames":{ - "shape":"CacheSecurityGroupNameList", - "documentation":"A list of cache security group names to associate with this replication group.
" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIdsList", - "documentation":"One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
" - }, - "SnapshotArns":{ - "shape":"SnapshotArnsList", - "documentation":"A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.
Note: This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.
Note: This parameter is only valid if the Engine parameter is redis.
The weekly time range (in UTC) during which system maintenance can occur.
Example: sun:05:00-sun:09:00
The port number on which each member of the replication group will accept connections.
" - }, - "NotificationTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.
Default: true
The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" - }, - "SnapshotWindow":{ - "shape":"String", - "documentation":"The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the Engine parameter is redis.
Represents the input of a CreateReplicationGroup operation.
" - }, - "CreateSnapshotMessage":{ - "type":"structure", - "required":[ - "CacheClusterId", - "SnapshotName" - ], - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.
" - }, - "SnapshotName":{ - "shape":"String", - "documentation":"A name for the snapshot being created.
" - } - }, - "documentation":"Represents the input of a CreateSnapshot operation.
" - }, - "DeleteCacheClusterMessage":{ - "type":"structure", - "required":["CacheClusterId"], - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
" - }, - "FinalSnapshotIdentifier":{ - "shape":"String", - "documentation":"The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.
" - } - }, - "documentation":"Represents the input of a DeleteCacheCluster operation.
" - }, - "DeleteCacheParameterGroupMessage":{ - "type":"structure", - "required":["CacheParameterGroupName"], - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group to delete.
" - } - }, - "documentation":"Represents the input of a DeleteCacheParameterGroup operation.
" - }, - "DeleteCacheSecurityGroupMessage":{ - "type":"structure", - "required":["CacheSecurityGroupName"], - "members":{ - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cache security group to delete.
" - } - }, - "documentation":"Represents the input of a DeleteCacheSecurityGroup operation.
" - }, - "DeleteCacheSubnetGroupMessage":{ - "type":"structure", - "required":["CacheSubnetGroupName"], - "members":{ - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cache subnet group to delete.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
" - } - }, - "documentation":"Represents the input of a DeleteCacheSubnetGroup operation.
" - }, - "DeleteReplicationGroupMessage":{ - "type":"structure", - "required":["ReplicationGroupId"], - "members":{ - "ReplicationGroupId":{ - "shape":"String", - "documentation":"The identifier for the cluster to be deleted. This parameter is not case sensitive.
" - }, - "RetainPrimaryCluster":{ - "shape":"BooleanOptional", - "documentation":"If set to true, all of the read replicas will be deleted, but the primary node will be retained.
" - }, - "FinalSnapshotIdentifier":{ - "shape":"String", - "documentation":"The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.
" - } - }, - "documentation":"Represents the input of a DeleteReplicationGroup operation.
" - }, - "DeleteSnapshotMessage":{ - "type":"structure", - "required":["SnapshotName"], - "members":{ - "SnapshotName":{ - "shape":"String", - "documentation":"The name of the snapshot to be deleted.
" - } - }, - "documentation":"Represents the input of a DeleteSnapshot operation.
" - }, - "DescribeCacheClustersMessage":{ - "type":"structure", - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "ShowCacheNodeInfo":{ - "shape":"BooleanOptional", - "documentation":"An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
" - } - }, - "documentation":"Represents the input of a DescribeCacheClusters operation.
" - }, - "DescribeCacheEngineVersionsMessage":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"The cache engine to return. Valid values: memcached | redis
The cache engine version to return.
Example: 1.4.14
The name of a specific cache parameter group family to return details for.
Constraints:
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DefaultOnly":{ - "shape":"Boolean", - "documentation":"If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
" - } - }, - "documentation":"Represents the input of a DescribeCacheEngineVersions operation.
" - }, - "DescribeCacheParameterGroupsMessage":{ - "type":"structure", - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of a specific cache parameter group to return details for.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeCacheParameterGroups operation.
" - }, - "DescribeCacheParametersMessage":{ - "type":"structure", - "required":["CacheParameterGroupName"], - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of a specific cache parameter group to return details for.
" - }, - "Source":{ - "shape":"String", - "documentation":"The parameter types to return.
Valid values: user | system | engine-default
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeCacheParameters operation.
" - }, - "DescribeCacheSecurityGroupsMessage":{ - "type":"structure", - "members":{ - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cache security group to return details for.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeCacheSecurityGroups operation.
" - }, - "DescribeCacheSubnetGroupsMessage":{ - "type":"structure", - "members":{ - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cache subnet group to return details for.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeCacheSubnetGroups operation.
" - }, - "DescribeEngineDefaultParametersMessage":{ - "type":"structure", - "required":["CacheParameterGroupFamily"], - "members":{ - "CacheParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeEngineDefaultParameters operation.
" - }, - "DescribeEventsMessage":{ - "type":"structure", - "members":{ - "SourceIdentifier":{ - "shape":"String", - "documentation":"The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
" - }, - "EndTime":{ - "shape":"TStamp", - "documentation":"The end of the time interval for which to retrieve events, specified in ISO 8601 format.
" - }, - "Duration":{ - "shape":"IntegerOptional", - "documentation":"The number of minutes' worth of events to retrieve.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeEvents operation.
" - }, - "DescribeReplicationGroupsMessage":{ - "type":"structure", - "members":{ - "ReplicationGroupId":{ - "shape":"String", - "documentation":"The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeReplicationGroups operation.
" - }, - "DescribeReservedCacheNodesMessage":{ - "type":"structure", - "members":{ - "ReservedCacheNodeId":{ - "shape":"String", - "documentation":"The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
" - }, - "ReservedCacheNodesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
" - }, - "CacheNodeType":{ - "shape":"String", - "documentation":"The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
" - }, - "Duration":{ - "shape":"String", - "documentation":"The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeReservedCacheNodes operation.
" - }, - "DescribeReservedCacheNodesOfferingsMessage":{ - "type":"structure", - "members":{ - "ReservedCacheNodesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
" - }, - "Duration":{ - "shape":"String", - "documentation":"Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - } - }, - "documentation":"Represents the input of a DescribeReservedCacheNodesOfferings operation.
" - }, - "DescribeSnapshotsListMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "Snapshots":{ - "shape":"SnapshotList", - "documentation":"A list of snapshots. Each item in the list contains detailed information about one snapshot.
" - } - }, - "documentation":"Represents the output of a DescribeSnapshots operation.
" - }, - "DescribeSnapshotsMessage":{ - "type":"structure", - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
" - }, - "SnapshotName":{ - "shape":"String", - "documentation":"A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
" - }, - "SnapshotSource":{ - "shape":"String", - "documentation":"If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 50
Constraints: minimum 20; maximum 50.
" - } - }, - "documentation":"Represents the input of a DescribeSnapshotsMessage operation.
" - }, - "Double":{"type":"double"}, - "EC2SecurityGroup":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"The status of the Amazon EC2 security group.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"The name of the Amazon EC2 security group.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The AWS account ID of the Amazon EC2 security group owner.
" - } - }, - "documentation":"Provides ownership and status information for an Amazon EC2 security group.
" - }, - "EC2SecurityGroupList":{ - "type":"list", - "member":{ - "shape":"EC2SecurityGroup", - "locationName":"EC2SecurityGroup" - } - }, - "Endpoint":{ - "type":"structure", - "members":{ - "Address":{ - "shape":"String", - "documentation":"The DNS hostname of the cache node.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"The port number that the cache engine is listening on.
" - } - }, - "documentation":"Represents the information required for client programs to connect to a cache node.
" - }, - "EngineDefaults":{ - "type":"structure", - "members":{ - "CacheParameterGroupFamily":{ - "shape":"String", - "documentation":"Specifies the name of the cache parameter group family to which the engine default parameters apply.
" - }, - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "Parameters":{ - "shape":"ParametersList", - "documentation":"Contains a list of engine default parameters.
" - }, - "CacheNodeTypeSpecificParameters":{ - "shape":"CacheNodeTypeSpecificParametersList", - "documentation":"A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
" - } - }, - "wrapper":true, - "documentation":"Represents the output of a DescribeEngineDefaultParameters operation.
" - }, - "Event":{ - "type":"structure", - "members":{ - "SourceIdentifier":{ - "shape":"String", - "documentation":"The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.
" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.
" - }, - "Message":{ - "shape":"String", - "documentation":"The text of the event.
" - }, - "Date":{ - "shape":"TStamp", - "documentation":"The date and time when the event occurred.
" - } - }, - "documentation":"Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.
" - }, - "EventList":{ - "type":"list", - "member":{ - "shape":"Event", - "locationName":"Event" - } - }, - "EventsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "Events":{ - "shape":"EventList", - "documentation":"A list of events. Each element in the list contains detailed information about one event.
" - } - }, - "documentation":"Represents the output of a DescribeEvents operation.
" - }, - "InsufficientCacheClusterCapacityFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientCacheClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node type is not available in the specified Availability Zone.
" - }, - "Integer":{"type":"integer"}, - "IntegerOptional":{"type":"integer"}, - "InvalidCacheClusterStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidCacheClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache cluster is not in the available state.
" - }, - "InvalidCacheParameterGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidCacheParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache parameter group does not allow the requested action to occur.
" - }, - "InvalidCacheSecurityGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidCacheSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the cache security group does not allow deletion.
" - }, - "InvalidParameterCombinationException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"AwsQueryErrorMessage", - "documentation":"Two or more parameters that must not be used together were used together.
" - } - }, - "error":{ - "code":"InvalidParameterCombination", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more incompatible parameters were specified.
" - }, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"AwsQueryErrorMessage", - "documentation":"A parameter value is invalid.
" - } - }, - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - "InvalidReplicationGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidReplicationGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested replication group is not in the available state.
" - }, - "InvalidSnapshotStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The current state of the snapshot does not allow the requested action to occur.
" - }, - "InvalidSubnet":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An invalid subnet identifier was specified.
" - }, - "InvalidVPCNetworkStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC network is in an invalid state.
" - }, - "ModifyCacheClusterMessage":{ - "type":"structure", - "required":["CacheClusterId"], - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The cache cluster identifier. This value is stored as a lowercase string.
" - }, - "NumCacheNodes":{ - "shape":"IntegerOptional", - "documentation":"The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For cache clusters running Redis, the value of NumCacheNodesmust be 1.
Note:
Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.
Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values: single-az | cross-az.
This option is only supported for Memcached cache clusters.
" - }, - "NewAvailabilityZones":{ - "shape":"PreferredAvailabilityZoneList", - "documentation":"The list of Availability Zones where the new Memcached cache nodes will be created.
This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.NumCacheNodes=6 ((3 + 2) + 1)NumCacheNodes=3 to cancel all pending actions.The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
| Scenarios | Pending Operation | New Request | Results |
|---|---|---|---|
| Scenario-1 | Delete | Delete | The new delete, pending or immediate, replaces the pending delete. |
| Scenario-2 | Delete | Create | The new create, pending or immediate, replaces the pending delete. |
| Scenario-3 | Create | Delete | The new delete, pending or immediate, replaces the pending create. |
| Scenario-4 | Create | Create | The new create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending. |
Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".
" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIdsList", - "documentation":"Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.
" - }, - "NotificationTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
" - }, - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
" - }, - "NotificationTopicStatus":{ - "shape":"String", - "documentation":"The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
Valid values: active | inactive
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.
If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.Valid values: true | false
Default: false
The upgraded version of the cache engine to be run on the cache nodes.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
Valid values: true | false
Default: true
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
" - } - }, - "documentation":"Represents the input of a ModifyCacheCluster operation.
" - }, - "ModifyCacheParameterGroupMessage":{ - "type":"structure", - "required":[ - "CacheParameterGroupName", - "ParameterNameValues" - ], - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group to modify.
" - }, - "ParameterNameValues":{ - "shape":"ParameterNameValueList", - "documentation":"An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
" - } - }, - "documentation":"Represents the input of a ModifyCacheParameterGroup operation.
" - }, - "ModifyCacheSubnetGroupMessage":{ - "type":"structure", - "required":["CacheSubnetGroupName"], - "members":{ - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
A description for the cache subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"The EC2 subnet IDs for the cache subnet group.
" - } - }, - "documentation":"Represents the input of a ModifyCacheSubnetGroup operation.
" - }, - "ModifyReplicationGroupMessage":{ - "type":"structure", - "required":["ReplicationGroupId"], - "members":{ - "ReplicationGroupId":{ - "shape":"String", - "documentation":"The identifier of the replication group to modify.
" - }, - "ReplicationGroupDescription":{ - "shape":"String", - "documentation":"A description for the replication group. Maximum length is 255 characters.
" - }, - "PrimaryClusterId":{ - "shape":"String", - "documentation":"If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.
" - }, - "SnapshottingClusterId":{ - "shape":"String", - "documentation":"The cache cluster ID that will be used as the daily snapshot source for the replication group.
" - }, - "AutomaticFailoverEnabled":{ - "shape":"BooleanOptional", - "documentation":"Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".
" - }, - "SecurityGroupIds":{ - "shape":"SecurityGroupIdsList", - "documentation":"Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.
" - }, - "NotificationTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
" - }, - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
" - }, - "NotificationTopicStatus":{ - "shape":"String", - "documentation":"The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values: active | inactive
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
The upgraded version of the cache engine to be run on the cache clusters in the replication group.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Determines whether minor engine upgrades will be applied automatically to all of the clusters in the replication group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
" - } - }, - "documentation":"Represents the input of a ModifyReplicationGroups operation.
" - }, - "NodeGroup":{ - "type":"structure", - "members":{ - "NodeGroupId":{ - "shape":"String", - "documentation":"The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
" - }, - "Status":{ - "shape":"String", - "documentation":"The current state of this replication group - creating, available, etc.
" - }, - "PrimaryEndpoint":{"shape":"Endpoint"}, - "NodeGroupMembers":{ - "shape":"NodeGroupMemberList", - "documentation":"A list containing information about individual nodes within the node group.
" - } - }, - "documentation":"Represents a collection of cache nodes in a replication group.
" - }, - "NodeGroupList":{ - "type":"list", - "member":{ - "shape":"NodeGroup", - "locationName":"NodeGroup" - } - }, - "NodeGroupMember":{ - "type":"structure", - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The ID of the cache cluster to which the node belongs.
" - }, - "CacheNodeId":{ - "shape":"String", - "documentation":"The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
" - }, - "ReadEndpoint":{"shape":"Endpoint"}, - "PreferredAvailabilityZone":{ - "shape":"String", - "documentation":"The name of the Availability Zone in which the node is located.
" - }, - "CurrentRole":{ - "shape":"String", - "documentation":"The role that is currently assigned to the node - primary or replica.
" - } - }, - "documentation":"Represents a single node within a node group.
" - }, - "NodeGroupMemberList":{ - "type":"list", - "member":{ - "shape":"NodeGroupMember", - "locationName":"NodeGroupMember" - } - }, - "NodeQuotaForClusterExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"NodeQuotaForClusterExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.
" - }, - "NodeQuotaForCustomerExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"NodeQuotaForCustomerExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
" - }, - "NodeSnapshot":{ - "type":"structure", - "members":{ - "CacheNodeId":{ - "shape":"String", - "documentation":"The cache node identifier for the node in the source cache cluster.
" - }, - "CacheSize":{ - "shape":"String", - "documentation":"The size of the cache on the source cache node.
" - }, - "CacheNodeCreateTime":{ - "shape":"TStamp", - "documentation":"The date and time when the cache node was created in the source cache cluster.
" - }, - "SnapshotCreateTime":{ - "shape":"TStamp", - "documentation":"The date and time when the source node's metadata and cache data set was obtained for the snapshot.
" - } - }, - "wrapper":true, - "documentation":"Represents an individual cache node in a snapshot of a cache cluster.
" - }, - "NodeSnapshotList":{ - "type":"list", - "member":{ - "shape":"NodeSnapshot", - "locationName":"NodeSnapshot" - } - }, - "NotificationConfiguration":{ - "type":"structure", - "members":{ - "TopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) that identifies the topic.
" - }, - "TopicStatus":{ - "shape":"String", - "documentation":"The current state of the topic.
" - } - }, - "documentation":"Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
" - }, - "Parameter":{ - "type":"structure", - "members":{ - "ParameterName":{ - "shape":"String", - "documentation":"The name of the parameter.
" - }, - "ParameterValue":{ - "shape":"String", - "documentation":"The value of the parameter.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the parameter.
" - }, - "Source":{ - "shape":"String", - "documentation":"The source of the parameter.
" - }, - "DataType":{ - "shape":"String", - "documentation":"The valid data type for the parameter.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"The valid range of values for the parameter.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":"Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest cache engine version to which the parameter can apply.
" - } - }, - "documentation":"Describes an individual setting that controls some aspect of ElastiCache behavior.
" - }, - "ParameterNameValue":{ - "type":"structure", - "members":{ - "ParameterName":{ - "shape":"String", - "documentation":"The name of the parameter.
" - }, - "ParameterValue":{ - "shape":"String", - "documentation":"The value of the parameter.
" - } - }, - "documentation":"Describes a name-value pair that is used to update the value of a parameter.
" - }, - "ParameterNameValueList":{ - "type":"list", - "member":{ - "shape":"ParameterNameValue", - "locationName":"ParameterNameValue" - } - }, - "ParametersList":{ - "type":"list", - "member":{ - "shape":"Parameter", - "locationName":"Parameter" - } - }, - "PendingAutomaticFailoverStatus":{ - "type":"string", - "enum":[ - "enabled", - "disabled" - ] - }, - "PendingModifiedValues":{ - "type":"structure", - "members":{ - "NumCacheNodes":{ - "shape":"IntegerOptional", - "documentation":"The new number of cache nodes for the cache cluster.
" - }, - "CacheNodeIdsToRemove":{ - "shape":"CacheNodeIdsList", - "documentation":"A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The new cache engine version that the cache cluster will run.
" - } - }, - "documentation":"A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.
" - }, - "PreferredAvailabilityZoneList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"PreferredAvailabilityZone" - } - }, - "PurchaseReservedCacheNodesOfferingMessage":{ - "type":"structure", - "required":["ReservedCacheNodesOfferingId"], - "members":{ - "ReservedCacheNodesOfferingId":{ - "shape":"String", - "documentation":"The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
" - }, - "ReservedCacheNodeId":{ - "shape":"String", - "documentation":"A customer-specified identifier to track this reservation.
Example: myreservationID
" - }, - "CacheNodeCount":{ - "shape":"IntegerOptional", - "documentation":"The number of cache node instances to reserve.
Default: 1
Represents the input of a PurchaseReservedCacheNodesOffering operation.
" - }, - "RebootCacheClusterMessage":{ - "type":"structure", - "required":[ - "CacheClusterId", - "CacheNodeIdsToReboot" - ], - "members":{ - "CacheClusterId":{ - "shape":"String", - "documentation":"The cache cluster identifier. This parameter is stored as a lowercase string.
" - }, - "CacheNodeIdsToReboot":{ - "shape":"CacheNodeIdsList", - "documentation":"A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.
" - } - }, - "documentation":"Represents the input of a RebootCacheCluster operation.
" - }, - "RecurringCharge":{ - "type":"structure", - "members":{ - "RecurringChargeAmount":{ - "shape":"Double", - "documentation":"The monetary amount of the recurring charge.
" - }, - "RecurringChargeFrequency":{ - "shape":"String", - "documentation":"The frequency of the recurring charge.
" - } - }, - "wrapper":true, - "documentation":"Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
" - }, - "RecurringChargeList":{ - "type":"list", - "member":{ - "shape":"RecurringCharge", - "locationName":"RecurringCharge" - } - }, - "ReplicationGroup":{ - "type":"structure", - "members":{ - "ReplicationGroupId":{ - "shape":"String", - "documentation":"The identifier for the replication group.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the replication group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The current state of this replication group - creating, available, etc.
" - }, - "PendingModifiedValues":{ - "shape":"ReplicationGroupPendingModifiedValues", - "documentation":"A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
" - }, - "MemberClusters":{ - "shape":"ClusterIdList", - "documentation":"The names of all the cache clusters that are part of this replication group.
" - }, - "NodeGroups":{ - "shape":"NodeGroupList", - "documentation":"A single element list with information about the nodes in the replication group.
" - }, - "SnapshottingClusterId":{ - "shape":"String", - "documentation":"The cache cluster ID that is used as the daily snapshot source for the replication group.
" - }, - "AutomaticFailover":{ - "shape":"AutomaticFailoverStatus", - "documentation":"Indicates the status of automatic failover for this replication group.
" - } - }, - "wrapper":true, - "documentation":"Contains all of the attributes of a specific replication group.
" - }, - "ReplicationGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReplicationGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group already exists.
" - }, - "ReplicationGroupList":{ - "type":"list", - "member":{ - "shape":"ReplicationGroup", - "locationName":"ReplicationGroup" - } - }, - "ReplicationGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "ReplicationGroups":{ - "shape":"ReplicationGroupList", - "documentation":"A list of replication groups. Each item in the list contains detailed information about one replication group.
" - } - }, - "documentation":"Represents the output of a DescribeReplicationGroups operation.
" - }, - "ReplicationGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReplicationGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified replication group does not exist.
" - }, - "ReplicationGroupPendingModifiedValues":{ - "type":"structure", - "members":{ - "PrimaryClusterId":{ - "shape":"String", - "documentation":"The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.
Indicates the status of automatic failover for this replication group.
" - } - }, - "documentation":"The settings to be applied to the replication group, either immediately or during the next maintenance window.
" - }, - "ReservedCacheNode":{ - "type":"structure", - "members":{ - "ReservedCacheNodeId":{ - "shape":"String", - "documentation":"The unique identifier for the reservation.
" - }, - "ReservedCacheNodesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier.
" - }, - "CacheNodeType":{ - "shape":"String", - "documentation":"The cache node type for the reserved cache nodes.
" - }, - "StartTime":{ - "shape":"TStamp", - "documentation":"The time the reservation started.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the reservation in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed price charged for this reserved cache node.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly price charged for this reserved cache node.
" - }, - "CacheNodeCount":{ - "shape":"Integer", - "documentation":"The number of cache nodes that have been reserved.
" - }, - "ProductDescription":{ - "shape":"String", - "documentation":"The description of the reserved cache node.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type of this reserved cache node.
" - }, - "State":{ - "shape":"String", - "documentation":"The state of the reserved cache node.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring price charged to run this reserved cache node.
" - } - }, - "wrapper":true, - "documentation":"Represents the output of a PurchaseReservedCacheNodesOffering operation.
" - }, - "ReservedCacheNodeAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedCacheNodeAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a reservation with the given identifier.
" - }, - "ReservedCacheNodeList":{ - "type":"list", - "member":{ - "shape":"ReservedCacheNode", - "locationName":"ReservedCacheNode" - } - }, - "ReservedCacheNodeMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "ReservedCacheNodes":{ - "shape":"ReservedCacheNodeList", - "documentation":"A list of reserved cache nodes. Each element in the list contains detailed information about one node.
" - } - }, - "documentation":"Represents the output of a DescribeReservedCacheNodes operation.
" - }, - "ReservedCacheNodeNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedCacheNodeNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested reserved cache node was not found.
" - }, - "ReservedCacheNodeQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedCacheNodeQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the user's cache node quota.
" - }, - "ReservedCacheNodesOffering":{ - "type":"structure", - "members":{ - "ReservedCacheNodesOfferingId":{ - "shape":"String", - "documentation":"A unique identifier for the reserved cache node offering.
" - }, - "CacheNodeType":{ - "shape":"String", - "documentation":"The cache node type for the reserved cache node.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the offering. in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed price charged for this offering.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly price charged for this offering.
" - }, - "ProductDescription":{ - "shape":"String", - "documentation":"The cache engine used by the offering.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring price charged to run this reserved cache node.
" - } - }, - "wrapper":true, - "documentation":"Describes all of the attributes of a reserved cache node offering.
" - }, - "ReservedCacheNodesOfferingList":{ - "type":"list", - "member":{ - "shape":"ReservedCacheNodesOffering", - "locationName":"ReservedCacheNodesOffering" - } - }, - "ReservedCacheNodesOfferingMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":"Provides an identifier to allow retrieval of paginated results.
" - }, - "ReservedCacheNodesOfferings":{ - "shape":"ReservedCacheNodesOfferingList", - "documentation":"A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
" - } - }, - "documentation":"Represents the output of a DescribeReservedCacheNodesOfferings operation.
" - }, - "ReservedCacheNodesOfferingNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedCacheNodesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested cache node offering does not exist.
" - }, - "ResetCacheParameterGroupMessage":{ - "type":"structure", - "required":[ - "CacheParameterGroupName", - "ParameterNameValues" - ], - "members":{ - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cache parameter group to reset.
" - }, - "ResetAllParameters":{ - "shape":"Boolean", - "documentation":"If true, all parameters in the cache parameter group will be reset to default values. If false, no such action occurs.
Valid values: true | false
An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.
" - } - }, - "documentation":"Represents the input of a ResetCacheParameterGroup operation.
" - }, - "RevokeCacheSecurityGroupIngressMessage":{ - "type":"structure", - "required":[ - "CacheSecurityGroupName", - "EC2SecurityGroupName", - "EC2SecurityGroupOwnerId" - ], - "members":{ - "CacheSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cache security group to revoke ingress from.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"The name of the Amazon EC2 security group to revoke access from.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
" - } - }, - "documentation":"Represents the input of a RevokeCacheSecurityGroupIngress operation.
" - }, - "SecurityGroupIdsList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SecurityGroupId" - } - }, - "SecurityGroupMembership":{ - "type":"structure", - "members":{ - "SecurityGroupId":{ - "shape":"String", - "documentation":"The identifier of the cache security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
" - } - }, - "documentation":"Represents a single cache security group and its status..
" - }, - "SecurityGroupMembershipList":{ - "type":"list", - "member":{"shape":"SecurityGroupMembership"} - }, - "Snapshot":{ - "type":"structure", - "members":{ - "SnapshotName":{ - "shape":"String", - "documentation":"The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
" - }, - "CacheClusterId":{ - "shape":"String", - "documentation":"The user-supplied identifier of the source cache cluster.
" - }, - "SnapshotStatus":{ - "shape":"String", - "documentation":"The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cache cluster.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The name of the cache engine (memcached or redis) used by the source cache cluster.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version of the cache engine version that is used by the source cache cluster.
" - }, - "NumCacheNodes":{ - "shape":"IntegerOptional", - "documentation":"The number of cache nodes in the source cache cluster.
" - }, - "PreferredAvailabilityZone":{ - "shape":"String", - "documentation":"The name of the Availability Zone in which the source cache cluster is located.
" - }, - "CacheClusterCreateTime":{ - "shape":"TStamp", - "documentation":"The date and time when the source cache cluster was created.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.
" - }, - "TopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The port number used by each cache nodes in the source cache cluster.
" - }, - "CacheParameterGroupName":{ - "shape":"String", - "documentation":"The cache parameter group that is associated with the source cache cluster.
" - }, - "CacheSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cache subnet group associated with the source cache cluster.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"For the source cache cluster, indicates whether minor version patches are applied automatically (true) or not (false).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
" - }, - "NodeSnapshots":{ - "shape":"NodeSnapshotList", - "documentation":"A list of the cache nodes in the source cache cluster.
" - } - }, - "wrapper":true, - "documentation":"Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
" - }, - "SnapshotAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You already have a snapshot with the given name.
" - }, - "SnapshotArnsList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SnapshotArn" - } - }, - "SnapshotFeatureNotSupportedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotFeatureNotSupportedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
" - }, - "SnapshotList":{ - "type":"list", - "member":{ - "shape":"Snapshot", - "locationName":"Snapshot" - } - }, - "SnapshotNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested snapshot name does not refer to an existing snapshot.
" - }, - "SnapshotQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request cannot be processed because it would exceed the maximum number of snapshots.
" - }, - "SourceType":{ - "type":"string", - "enum":[ - "cache-cluster", - "cache-parameter-group", - "cache-security-group", - "cache-subnet-group" - ] - }, - "String":{"type":"string"}, - "Subnet":{ - "type":"structure", - "members":{ - "SubnetIdentifier":{ - "shape":"String", - "documentation":"The unique identifier for the subnet
" - }, - "SubnetAvailabilityZone":{ - "shape":"AvailabilityZone", - "documentation":"The Availability Zone associated with the subnet
" - } - }, - "documentation":"Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" - }, - "SubnetIdentifierList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SubnetIdentifier" - } - }, - "SubnetInUse":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubnetInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is being used by another cache subnet group.
" - }, - "SubnetList":{ - "type":"list", - "member":{ - "shape":"Subnet", - "locationName":"Subnet" - } - }, - "TStamp":{"type":"timestamp"}, - "AuthorizeCacheSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} - } - }, - "CopySnapshotResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "CreateCacheClusterResult":{ - "type":"structure", - "members":{ - "CacheCluster":{"shape":"CacheCluster"} - } - }, - "CreateCacheParameterGroupResult":{ - "type":"structure", - "members":{ - "CacheParameterGroup":{"shape":"CacheParameterGroup"} - } - }, - "CreateCacheSecurityGroupResult":{ - "type":"structure", - "members":{ - "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} - } - }, - "CreateCacheSubnetGroupResult":{ - "type":"structure", - "members":{ - "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} - } - }, - "CreateReplicationGroupResult":{ - "type":"structure", - "members":{ - "ReplicationGroup":{"shape":"ReplicationGroup"} - } - }, - "CreateSnapshotResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "DeleteCacheClusterResult":{ - "type":"structure", - "members":{ - "CacheCluster":{"shape":"CacheCluster"} - } - }, - "DeleteReplicationGroupResult":{ - "type":"structure", - "members":{ - "ReplicationGroup":{"shape":"ReplicationGroup"} - } - }, - "DeleteSnapshotResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "DescribeEngineDefaultParametersResult":{ - "type":"structure", - "members":{ - "EngineDefaults":{"shape":"EngineDefaults"} - } - }, - "ModifyCacheClusterResult":{ - "type":"structure", - "members":{ - "CacheCluster":{"shape":"CacheCluster"} - } - }, - "ModifyCacheSubnetGroupResult":{ - "type":"structure", - "members":{ - "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} - } - }, - "ModifyReplicationGroupResult":{ - "type":"structure", - "members":{ - "ReplicationGroup":{"shape":"ReplicationGroup"} - } - }, - "PurchaseReservedCacheNodesOfferingResult":{ - "type":"structure", - "members":{ - "ReservedCacheNode":{"shape":"ReservedCacheNode"} - } - }, - "RebootCacheClusterResult":{ - "type":"structure", - "members":{ - "CacheCluster":{"shape":"CacheCluster"} - } - }, - "RevokeCacheSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} - } - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/elasticache/2014-09-30.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/elasticache/2014-09-30.paginators.json deleted file mode 100644 index 8724740d6f..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/elasticache/2014-09-30.paginators.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "pagination": { - "DescribeCacheClusters": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "CacheClusters" - }, - "DescribeCacheEngineVersions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "CacheEngineVersions" - }, - "DescribeCacheParameterGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "CacheParameterGroups" - }, - "DescribeCacheParameters": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Parameters" - }, - "DescribeCacheSecurityGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "CacheSecurityGroups" - }, - "DescribeCacheSubnetGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "CacheSubnetGroups" - }, - "DescribeEngineDefaultParameters": { - "input_token": "Marker", - "output_token": "EngineDefaults.Marker", - "limit_key": "MaxRecords", - "result_key": "EngineDefaults.Parameters" - }, - "DescribeEvents": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Events" - }, - "DescribeReservedCacheNodes": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedCacheNodes" - }, - "DescribeReservedCacheNodesOfferings": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedCacheNodesOfferings" - }, - "DescribeReplicationGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReplicationGroups" - }, - "DescribeSnapshots": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Snapshots" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/elasticbeanstalk/2010-12-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/elasticbeanstalk/2010-12-01.normal.json deleted file mode 100644 index dfdf988ce3..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/elasticbeanstalk/2010-12-01.normal.json +++ /dev/null @@ -1,2442 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-12-01", - "endpointPrefix":"elasticbeanstalk", - "serviceAbbreviation":"Elastic Beanstalk", - "serviceFullName":"AWS Elastic Beanstalk", - "signatureVersion":"v4", - "xmlNamespace":"http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/", - "protocol":"query" - }, - "documentation":"This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.
AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
", - "operations":{ - "CheckDNSAvailability":{ - "name":"CheckDNSAvailability", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CheckDNSAvailabilityMessage", - "documentation":"Results message indicating whether a CNAME is available.
" - }, - "output":{ - "shape":"CheckDNSAvailabilityResultMessage", - "documentation":"Indicates if the specified CNAME is available.
", - "resultWrapper":"CheckDNSAvailabilityResult" - }, - "documentation":"Checks if the specified CNAME is available.
" - }, - "CreateApplication":{ - "name":"CreateApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateApplicationMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"ApplicationDescriptionMessage", - "documentation":"Result message containing a single description of an application.
", - "resultWrapper":"CreateApplicationResult" - }, - "errors":[ - { - "shape":"TooManyApplicationsException", - "error":{ - "code":"TooManyApplicationsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit on the number of applications associated with their account.
" - } - ], - "documentation":" Creates an application that has one configuration template named default and no application versions.
Result message wrapping a single description of an application version.
", - "resultWrapper":"CreateApplicationVersionResult" - }, - "errors":[ - { - "shape":"TooManyApplicationsException", - "error":{ - "code":"TooManyApplicationsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit on the number of applications associated with their account.
" - }, - { - "shape":"TooManyApplicationVersionsException", - "exception":true, - "documentation":"The caller has exceeded the limit on the number of application versions associated with their account.
" - }, - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - }, - { - "shape":"S3LocationNotInServiceRegionException", - "error":{ - "code":"S3LocationNotInServiceRegionException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified S3 bucket does not belong to the S3 region in which the service is running.
" - } - ], - "documentation":"Creates an application version for the specified application.
" - }, - "CreateConfigurationTemplate":{ - "name":"CreateConfigurationTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateConfigurationTemplateMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"ConfigurationSettingsDescription", - "documentation":"Describes the settings for a configuration set.
", - "resultWrapper":"CreateConfigurationTemplateResult" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - }, - { - "shape":"TooManyConfigurationTemplatesException", - "error":{ - "code":"TooManyConfigurationTemplatesException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit on the number of configuration templates associated with their account.
" - } - ], - "documentation":"Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
" - }, - "CreateEnvironment":{ - "name":"CreateEnvironment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateEnvironmentMessage", - "documentation":"" - }, - "output":{ - "shape":"EnvironmentDescription", - "documentation":"Describes the properties of an environment.
", - "resultWrapper":"CreateEnvironmentResult" - }, - "errors":[ - { - "shape":"TooManyEnvironmentsException", - "error":{ - "code":"TooManyEnvironmentsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit of allowed environments associated with the account.
" - }, - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Launches an environment for the specified application using the specified configuration.
" - }, - "CreateStorageLocation":{ - "name":"CreateStorageLocation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"CreateStorageLocationResultMessage", - "documentation":"Results of a CreateStorageLocationResult call.
", - "resultWrapper":"CreateStorageLocationResult" - }, - "errors":[ - { - "shape":"TooManyBucketsException", - "error":{ - "code":"TooManyBucketsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.
" - }, - { - "shape":"S3SubscriptionRequiredException", - "error":{ - "code":"S3SubscriptionRequiredException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller does not have a subscription to Amazon S3.
" - }, - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
" - }, - "DeleteApplication":{ - "name":"DeleteApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteApplicationMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "errors":[ - { - "shape":"OperationInProgressException", - "error":{ - "code":"OperationInProgressFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
" - } - ], - "documentation":"Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
" - }, - "DeleteApplicationVersion":{ - "name":"DeleteApplicationVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteApplicationVersionMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "errors":[ - { - "shape":"SourceBundleDeletionException", - "error":{ - "code":"SourceBundleDeletionFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.
" - }, - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - }, - { - "shape":"OperationInProgressException", - "error":{ - "code":"OperationInProgressFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
" - }, - { - "shape":"S3LocationNotInServiceRegionException", - "error":{ - "code":"S3LocationNotInServiceRegionException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified S3 bucket does not belong to the S3 region in which the service is running.
" - } - ], - "documentation":"Deletes the specified version from the specified application.
" - }, - "DeleteConfigurationTemplate":{ - "name":"DeleteConfigurationTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteConfigurationTemplateMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "errors":[ - { - "shape":"OperationInProgressException", - "error":{ - "code":"OperationInProgressFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
" - } - ], - "documentation":"Deletes the specified configuration template.
" - }, - "DeleteEnvironmentConfiguration":{ - "name":"DeleteEnvironmentConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteEnvironmentConfigurationMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "documentation":"Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.
Result message containing a list of configuration descriptions.
" - }, - "output":{ - "shape":"ApplicationVersionDescriptionsMessage", - "documentation":"Result message wrapping a list of application version descriptions.
", - "resultWrapper":"DescribeApplicationVersionsResult" - }, - "documentation":"Returns descriptions for existing application versions.
" - }, - "DescribeApplications":{ - "name":"DescribeApplications", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeApplicationsMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"ApplicationDescriptionsMessage", - "documentation":"Result message containing a list of application descriptions.
", - "resultWrapper":"DescribeApplicationsResult" - }, - "documentation":"Returns the descriptions of existing applications.
" - }, - "DescribeConfigurationOptions":{ - "name":"DescribeConfigurationOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeConfigurationOptionsMessage", - "documentation":"Result message containig a list of application version descriptions.
" - }, - "output":{ - "shape":"ConfigurationOptionsDescription", - "documentation":"Describes the settings for a specified configuration set.
", - "resultWrapper":"DescribeConfigurationOptionsResult" - }, - "documentation":"Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
" - }, - "DescribeConfigurationSettings":{ - "name":"DescribeConfigurationSettings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeConfigurationSettingsMessage", - "documentation":"Result message containing all of the configuration settings for a specified solution stack or configuration template.
" - }, - "output":{ - "shape":"ConfigurationSettingsDescriptions", - "documentation":"The results from a request to change the configuration settings of an environment.
", - "resultWrapper":"DescribeConfigurationSettingsResult" - }, - "documentation":"Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
" - }, - "DescribeEnvironmentResources":{ - "name":"DescribeEnvironmentResources", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEnvironmentResourcesMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"EnvironmentResourceDescriptionsMessage", - "documentation":"Result message containing a list of environment resource descriptions.
", - "resultWrapper":"DescribeEnvironmentResourcesResult" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Returns AWS resources for this environment.
" - }, - "DescribeEnvironments":{ - "name":"DescribeEnvironments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEnvironmentsMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"EnvironmentDescriptionsMessage", - "documentation":"Result message containing a list of environment descriptions.
", - "resultWrapper":"DescribeEnvironmentsResult" - }, - "documentation":"Returns descriptions for existing environments.
" - }, - "DescribeEvents":{ - "name":"DescribeEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventsMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"EventDescriptionsMessage", - "documentation":"Result message wrapping a list of event descriptions.
", - "resultWrapper":"DescribeEventsResult" - }, - "documentation":"Returns list of event descriptions matching criteria up to the last 6 weeks.
" - }, - "ListAvailableSolutionStacks":{ - "name":"ListAvailableSolutionStacks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"ListAvailableSolutionStacksResultMessage", - "documentation":"A list of available AWS Elastic Beanstalk solution stacks.
", - "resultWrapper":"ListAvailableSolutionStacksResult" - }, - "documentation":"Returns a list of the available solution stack names.
" - }, - "RebuildEnvironment":{ - "name":"RebuildEnvironment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RebuildEnvironmentMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
" - }, - "RequestEnvironmentInfo":{ - "name":"RequestEnvironmentInfo", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RequestEnvironmentInfoMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "documentation":"Initiates a request to compile the specified type of information of the deployed environment.
Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Use RetrieveEnvironmentInfo to access the compiled information.
Related Topics
" - }, - "RestartAppServer":{ - "name":"RestartAppServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RestartAppServerMessage", - "documentation":"" - }, - "documentation":"Causes the environment to restart the application container server running on each Amazon EC2 instance.
" - }, - "RetrieveEnvironmentInfo":{ - "name":"RetrieveEnvironmentInfo", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RetrieveEnvironmentInfoMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"RetrieveEnvironmentInfoResultMessage", - "documentation":"Result message containing a description of the requested environment info.
", - "resultWrapper":"RetrieveEnvironmentInfoResult" - }, - "documentation":"Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
" - }, - "SwapEnvironmentCNAMEs":{ - "name":"SwapEnvironmentCNAMEs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SwapEnvironmentCNAMEsMessage", - "documentation":"" - }, - "documentation":"Swaps the CNAMEs of two environments.
" - }, - "TerminateEnvironment":{ - "name":"TerminateEnvironment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"TerminateEnvironmentMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"EnvironmentDescription", - "documentation":"Describes the properties of an environment.
", - "resultWrapper":"TerminateEnvironmentResult" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Terminates the specified environment.
" - }, - "UpdateApplication":{ - "name":"UpdateApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateApplicationMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"ApplicationDescriptionMessage", - "documentation":"Result message containing a single description of an application.
", - "resultWrapper":"UpdateApplicationResult" - }, - "documentation":"Updates the specified application to have the specified properties.
" - }, - "UpdateApplicationVersion":{ - "name":"UpdateApplicationVersion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateApplicationVersionMessage", - "documentation":"" - }, - "output":{ - "shape":"ApplicationVersionDescriptionMessage", - "documentation":"Result message wrapping a single description of an application version.
", - "resultWrapper":"UpdateApplicationVersionResult" - }, - "documentation":"Updates the specified application version to have the specified properties.
" - }, - "UpdateConfigurationTemplate":{ - "name":"UpdateConfigurationTemplate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateConfigurationTemplateMessage", - "documentation":"The result message containing the options for the specified solution stack.
" - }, - "output":{ - "shape":"ConfigurationSettingsDescription", - "documentation":"Describes the settings for a configuration set.
", - "resultWrapper":"UpdateConfigurationTemplateResult" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Updates the specified configuration template to have the specified properties or configuration option values.
Related Topics
" - }, - "UpdateEnvironment":{ - "name":"UpdateEnvironment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateEnvironmentMessage", - "documentation":"This documentation target is not reported in the API reference.
" - }, - "output":{ - "shape":"EnvironmentDescription", - "documentation":"Describes the properties of an environment.
", - "resultWrapper":"UpdateEnvironmentResult" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
A list of validation messages for a specified configuration template.
" - }, - "output":{ - "shape":"ConfigurationSettingsValidationMessages", - "documentation":"Provides a list of validation messages.
", - "resultWrapper":"ValidateConfigurationSettingsResult" - }, - "errors":[ - { - "shape":"InsufficientPrivilegesException", - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - } - ], - "documentation":"Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
" - } - }, - "shapes":{ - "ApplicationDescription":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application.
" - }, - "Description":{ - "shape":"Description", - "documentation":"User-defined description of the application.
" - }, - "DateCreated":{ - "shape":"CreationDate", - "documentation":"The date when the application was created.
" - }, - "DateUpdated":{ - "shape":"UpdateDate", - "documentation":"The date when the application was last modified.
" - }, - "Versions":{ - "shape":"VersionLabelsList", - "documentation":"The names of the versions for this application.
" - }, - "ConfigurationTemplates":{ - "shape":"ConfigurationTemplateNamesList", - "documentation":"The names of the configuration templates associated with this application.
" - } - }, - "documentation":"Describes the properties of an application.
" - }, - "ApplicationDescriptionList":{ - "type":"list", - "member":{"shape":"ApplicationDescription"} - }, - "ApplicationDescriptionMessage":{ - "type":"structure", - "members":{ - "Application":{ - "shape":"ApplicationDescription", - "documentation":"The ApplicationDescription of the application.
" - } - }, - "documentation":"Result message containing a single description of an application.
" - }, - "ApplicationDescriptionsMessage":{ - "type":"structure", - "members":{ - "Applications":{ - "shape":"ApplicationDescriptionList", - "documentation":"This parameter contains a list of ApplicationDescription.
" - } - }, - "documentation":"Result message containing a list of application descriptions.
" - }, - "ApplicationName":{ - "type":"string", - "min":1, - "max":100 - }, - "ApplicationNamesList":{ - "type":"list", - "member":{"shape":"ApplicationName"} - }, - "ApplicationVersionDescription":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with this release.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The description of this application version.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"A label uniquely identifying the version for the associated application.
" - }, - "SourceBundle":{ - "shape":"S3Location", - "documentation":"The location where the source bundle is located for this version.
" - }, - "DateCreated":{ - "shape":"CreationDate", - "documentation":"The creation date of the application version.
" - }, - "DateUpdated":{ - "shape":"UpdateDate", - "documentation":"The last modified date of the application version.
" - } - }, - "documentation":"Describes the properties of an application version.
" - }, - "ApplicationVersionDescriptionList":{ - "type":"list", - "member":{"shape":"ApplicationVersionDescription"} - }, - "ApplicationVersionDescriptionMessage":{ - "type":"structure", - "members":{ - "ApplicationVersion":{ - "shape":"ApplicationVersionDescription", - "documentation":"The ApplicationVersionDescription of the application version.
" - } - }, - "documentation":"Result message wrapping a single description of an application version.
" - }, - "ApplicationVersionDescriptionsMessage":{ - "type":"structure", - "members":{ - "ApplicationVersions":{ - "shape":"ApplicationVersionDescriptionList", - "documentation":"A list of ApplicationVersionDescription .
" - } - }, - "documentation":"Result message wrapping a list of application version descriptions.
" - }, - "AutoCreateApplication":{"type":"boolean"}, - "AutoScalingGroup":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceId", - "documentation":" The name of the AutoScalingGroup .
Describes an Auto Scaling launch configuration.
" - }, - "AutoScalingGroupList":{ - "type":"list", - "member":{"shape":"AutoScalingGroup"} - }, - "AvailableSolutionStackDetailsList":{ - "type":"list", - "member":{"shape":"SolutionStackDescription"} - }, - "AvailableSolutionStackNamesList":{ - "type":"list", - "member":{"shape":"SolutionStackName"} - }, - "CheckDNSAvailabilityMessage":{ - "type":"structure", - "required":["CNAMEPrefix"], - "members":{ - "CNAMEPrefix":{ - "shape":"DNSCnamePrefix", - "documentation":"The prefix used when this CNAME is reserved.
" - } - }, - "documentation":"Results message indicating whether a CNAME is available.
" - }, - "CheckDNSAvailabilityResultMessage":{ - "type":"structure", - "members":{ - "Available":{ - "shape":"CnameAvailability", - "documentation":"Indicates if the specified CNAME is available:
true : The CNAME is available.
true : The CNAME is not available.
true : The CNAME is available. false : The CNAME is not available. The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
" - } - }, - "documentation":"Indicates if the specified CNAME is available.
" - }, - "CnameAvailability":{"type":"boolean"}, - "ConfigurationDeploymentStatus":{ - "type":"string", - "enum":[ - "deployed", - "pending", - "failed" - ] - }, - "ConfigurationOptionDefaultValue":{"type":"string"}, - "ConfigurationOptionDescription":{ - "type":"structure", - "members":{ - "Namespace":{ - "shape":"OptionNamespace", - "documentation":"A unique namespace identifying the option's associated AWS resource.
" - }, - "Name":{ - "shape":"ConfigurationOptionName", - "documentation":"The name of the configuration option.
" - }, - "DefaultValue":{ - "shape":"ConfigurationOptionDefaultValue", - "documentation":"The default value for this configuration option.
" - }, - "ChangeSeverity":{ - "shape":"ConfigurationOptionSeverity", - "documentation":"An indication of which action is required if the value for this configuration option changes:
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption : There is no interruption to the environment or application availability. RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process. RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted. An indication of whether the user defined this configuration option:
true : This configuration option was defined by the user. It is a valid choice for specifying this as an Option to Remove when updating configuration settings.
false : This configuration was not defined by the user.
true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.
false : This configuration was not defined by the user. Constraint: You can remove only UserDefined options from a configuration.
Valid Values: true | false
An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar : Values for this option are a single selection from the possible values, or a unformatted string or numeric value governed by the MIN/MAX/Regex constraints:
List : Values for this option are multiple selections of the possible values.
Boolean : Values for this option are either true or false .
Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints. List : Values for this option are multiple selections from the possible values. Boolean : Values for this option are either true or false . If specified, values for the configuration option are selected from this list.
" - }, - "MinValue":{ - "shape":"OptionRestrictionMinValue", - "documentation":"If specified, the configuration option must be a numeric value greater than this value.
" - }, - "MaxValue":{ - "shape":"OptionRestrictionMaxValue", - "documentation":"If specified, the configuration option must be a numeric value less than this value.
" - }, - "MaxLength":{ - "shape":"OptionRestrictionMaxLength", - "documentation":"If specified, the configuration option must be a string value no longer than this value.
" - }, - "Regex":{ - "shape":"OptionRestrictionRegex", - "documentation":"If specified, the configuration option must be a string value that satisfies this regular expression.
" - } - }, - "documentation":"Describes the possible values for a configuration option.
" - }, - "ConfigurationOptionDescriptionsList":{ - "type":"list", - "member":{"shape":"ConfigurationOptionDescription"} - }, - "ConfigurationOptionName":{"type":"string"}, - "ConfigurationOptionPossibleValue":{"type":"string"}, - "ConfigurationOptionPossibleValues":{ - "type":"list", - "member":{"shape":"ConfigurationOptionPossibleValue"} - }, - "ConfigurationOptionSetting":{ - "type":"structure", - "members":{ - "Namespace":{ - "shape":"OptionNamespace", - "documentation":"A unique namespace identifying the option's associated AWS resource.
" - }, - "OptionName":{ - "shape":"ConfigurationOptionName", - "documentation":"The name of the configuration option.
" - }, - "Value":{ - "shape":"ConfigurationOptionValue", - "documentation":"The current value for the configuration option.
" - } - }, - "documentation":"A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
" - }, - "ConfigurationOptionSettingsList":{ - "type":"list", - "member":{"shape":"ConfigurationOptionSetting"} - }, - "ConfigurationOptionSeverity":{"type":"string"}, - "ConfigurationOptionValue":{"type":"string"}, - "ConfigurationOptionValueType":{ - "type":"string", - "enum":[ - "Scalar", - "List" - ] - }, - "ConfigurationOptionsDescription":{ - "type":"structure", - "members":{ - "SolutionStackName":{ - "shape":"SolutionStackName", - "documentation":"The name of the solution stack these configuration options belong to.
" - }, - "Options":{ - "shape":"ConfigurationOptionDescriptionsList", - "documentation":"A list of ConfigurationOptionDescription.
" - } - }, - "documentation":"Describes the settings for a specified configuration set.
" - }, - "ConfigurationSettingsDescription":{ - "type":"structure", - "members":{ - "SolutionStackName":{ - "shape":"SolutionStackName", - "documentation":"The name of the solution stack this configuration set uses.
" - }, - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with this configuration set.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":" If not null, the name of the configuration template for this configuration set.
Describes this configuration set.
" - }, - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":" If not null, the name of the environment for this configuration set.
If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
null: This configuration is not associated with a running environment.
pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed: This is the configuration that is currently deployed to the associated running environment.
failed: This is a draft configuration, that failed to successfully deploy.
null: This configuration is not associated with a running environment. pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. deployed: This is the configuration that is currently deployed to the associated running environment. failed: This is a draft configuration that failed to successfully deploy. The date (in UTC time) when this configuration set was created.
" - }, - "DateUpdated":{ - "shape":"UpdateDate", - "documentation":"The date (in UTC time) when this configuration set was last modified.
" - }, - "OptionSettings":{ - "shape":"ConfigurationOptionSettingsList", - "documentation":"A list of the configuration options and their values in this configuration set.
" - } - }, - "documentation":"Describes the settings for a configuration set.
" - }, - "ConfigurationSettingsDescriptionList":{ - "type":"list", - "member":{"shape":"ConfigurationSettingsDescription"} - }, - "ConfigurationSettingsDescriptions":{ - "type":"structure", - "members":{ - "ConfigurationSettings":{ - "shape":"ConfigurationSettingsDescriptionList", - "documentation":"A list of ConfigurationSettingsDescription.
" - } - }, - "documentation":"The results from a request to change the configuration settings of an environment.
" - }, - "ConfigurationSettingsValidationMessages":{ - "type":"structure", - "members":{ - "Messages":{ - "shape":"ValidationMessagesList", - "documentation":"A list of ValidationMessage.
" - } - }, - "documentation":"Provides a list of validation messages.
" - }, - "ConfigurationTemplateName":{ - "type":"string", - "min":1, - "max":100 - }, - "ConfigurationTemplateNamesList":{ - "type":"list", - "member":{"shape":"ConfigurationTemplateName"} - }, - "CreateApplicationMessage":{ - "type":"structure", - "required":["ApplicationName"], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application.
Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.
Describes the application.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "CreateApplicationVersionMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "VersionLabel" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":" The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
A label identifying this version.
Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Describes this version.
" - }, - "SourceBundle":{ - "shape":"S3Location", - "documentation":"The Amazon S3 bucket and key that identify the location of the source bundle for this version.
If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error. The maximum size allowed is 512 MB.
Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error.
Determines how the system behaves if the specified application for this version does not already exist:
true: Automatically creates the specified application for this version if it does not already exist.
false: Returns an InvalidParameterValue if the specified application for this version does not already exist.
true : Automatically creates the specified application for this release if it does not already exist. false : Throws an InvalidParameterValue if the specified application for this release does not already exist. Default: false
Valid Values: true | false
The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
" - }, - "SourceConfiguration":{ - "shape":"SourceConfiguration", - "documentation":"If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.
If no configuration template is found, returns an InvalidParameterValue error.
Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.
The ID of the environment used with this configuration template.
" - }, - "Description":{ - "shape":"Description", - "documentation":"Describes this configuration.
" - }, - "OptionSettings":{ - "shape":"ConfigurationOptionSettingsList", - "documentation":"If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "CreateEnvironmentMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "EnvironmentName" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
" - }, - "Description":{ - "shape":"Description", - "documentation":"Describes this environment.
" - }, - "CNAMEPrefix":{ - "shape":"DNSCnamePrefix", - "documentation":"If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
" - }, - "Tier":{ - "shape":"EnvironmentTier", - "documentation":"This specifies the tier to use for creating this environment.
" - }, - "Tags":{ - "shape":"Tags", - "documentation":"This specifies the tags applied to resources in the environment.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":" The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
" - }, - "OptionsToRemove":{ - "shape":"OptionsSpecifierList", - "documentation":"A list of custom user-defined configuration options to remove from the configuration set for this new environment.
" - } - }, - "documentation":"" - }, - "CreateStorageLocationResultMessage":{ - "type":"structure", - "members":{ - "S3Bucket":{ - "shape":"S3Bucket", - "documentation":"The name of the Amazon S3 bucket created.
" - } - }, - "documentation":"Results of a CreateStorageLocationResult call.
" - }, - "CreationDate":{"type":"timestamp"}, - "DNSCname":{ - "type":"string", - "min":1, - "max":255 - }, - "DNSCnamePrefix":{ - "type":"string", - "min":4, - "max":63 - }, - "DeleteApplicationMessage":{ - "type":"structure", - "required":["ApplicationName"], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application to delete.
" - }, - "TerminateEnvByForce":{ - "shape":"TerminateEnvForce", - "documentation":"When set to true, running environments will be terminated before deleting the application.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "DeleteApplicationVersionMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "VersionLabel" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application to delete releases from.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"The label of the version to delete.
" - }, - "DeleteSourceBundle":{ - "shape":"DeleteSourceBundle", - "documentation":"Indicates whether to delete the associated source bundle from Amazon S3:
true: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation. false: No action is taken on the Amazon S3 source bundle specified at time of creation. Valid Values: true | false
This documentation target is not reported in the API reference.
" - }, - "DeleteConfigurationTemplateMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "TemplateName" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application to delete the configuration template from.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration template to delete.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "DeleteEnvironmentConfigurationMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "EnvironmentName" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application the environment is associated with.
" - }, - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"The name of the environment to delete the draft configuration from.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "DeleteSourceBundle":{"type":"boolean"}, - "DescribeApplicationVersionsMessage":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application.
" - }, - "VersionLabels":{ - "shape":"VersionLabelsList", - "documentation":"If specified, restricts the returned descriptions to only include ones that have the specified version labels.
" - } - }, - "documentation":"Result message containing a list of configuration descriptions.
" - }, - "DescribeApplicationsMessage":{ - "type":"structure", - "members":{ - "ApplicationNames":{ - "shape":"ApplicationNamesList", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "DescribeConfigurationOptionsMessage":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration template whose configuration options you want to describe.
" - }, - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"The name of the environment whose configuration options you want to describe.
" - }, - "SolutionStackName":{ - "shape":"SolutionStackName", - "documentation":"The name of the solution stack whose configuration options you want to describe.
" - }, - "Options":{ - "shape":"OptionsSpecifierList", - "documentation":"If specified, restricts the descriptions to only the specified options.
" - } - }, - "documentation":"Result message containig a list of application version descriptions.
" - }, - "DescribeConfigurationSettingsMessage":{ - "type":"structure", - "required":["ApplicationName"], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The application for the environment or configuration template.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
Result message containing all of the configuration settings for a specified solution stack or configuration template.
" - }, - "DescribeEnvironmentResourcesMessage":{ - "type":"structure", - "members":{ - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
This documentation target is not reported in the API reference.
" - }, - "DescribeEnvironmentsMessage":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
" - }, - "EnvironmentIds":{ - "shape":"EnvironmentIdList", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
" - }, - "EnvironmentNames":{ - "shape":"EnvironmentNamesList", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
" - }, - "IncludeDeleted":{ - "shape":"IncludeDeleted", - "documentation":"Indicates whether to include deleted environments:
true: Environments that have been deleted after IncludedDeletedBackTo are displayed.
false: Do not include deleted environments.
If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
This documentation target is not reported in the API reference.
" - }, - "DescribeEventsMessage":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
" - }, - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
" - }, - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
" - }, - "RequestId":{ - "shape":"RequestId", - "documentation":"If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
" - }, - "Severity":{ - "shape":"EventSeverity", - "documentation":"If specified, limits the events returned from this call to include only those with the specified severity or higher.
" - }, - "StartTime":{ - "shape":"TimeFilterStart", - "documentation":"If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
" - }, - "EndTime":{ - "shape":"TimeFilterEnd", - "documentation":" If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
Specifies the maximum number of events that can be returned, beginning with the most recent event.
" - }, - "NextToken":{ - "shape":"Token", - "documentation":"Pagination token. If specified, the events return the next batch of results.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "Description":{ - "type":"string", - "max":200 - }, - "Ec2InstanceId":{"type":"string"}, - "EndpointURL":{"type":"string"}, - "EnvironmentDescription":{ - "type":"structure", - "members":{ - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"The name of this environment.
" - }, - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of this environment.
" - }, - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with this environment.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"The application version deployed in this environment.
" - }, - "SolutionStackName":{ - "shape":"SolutionStackName", - "documentation":" The name of the SolutionStack deployed with this environment.
The name of the configuration template used to originally launch this environment.
" - }, - "Description":{ - "shape":"Description", - "documentation":"Describes this environment.
" - }, - "EndpointURL":{ - "shape":"EndpointURL", - "documentation":"For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
" - }, - "CNAME":{ - "shape":"DNSCname", - "documentation":"The URL to the CNAME for this environment.
" - }, - "DateCreated":{ - "shape":"CreationDate", - "documentation":"The creation date for this environment.
" - }, - "DateUpdated":{ - "shape":"UpdateDate", - "documentation":"The last modified date for this environment.
" - }, - "Status":{ - "shape":"EnvironmentStatus", - "documentation":"The current operational status of the environment:
Launching: Environment is in the process of initial deployment. Updating: Environment is in the process of updating its configuration settings or application version. Ready: Environment is available to have an action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process. Terminated: Environment is not running. Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red : Indicates the environment is not working.
Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.
Green: Indicates the environment is healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and fully functional. Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request. Default: Grey
The description of the AWS resources used by this environment.
" - }, - "Tier":{ - "shape":"EnvironmentTier", - "documentation":"Describes the current tier of this environment.
" - } - }, - "documentation":"Describes the properties of an environment.
" - }, - "EnvironmentDescriptionsList":{ - "type":"list", - "member":{"shape":"EnvironmentDescription"} - }, - "EnvironmentDescriptionsMessage":{ - "type":"structure", - "members":{ - "Environments":{ - "shape":"EnvironmentDescriptionsList", - "documentation":"Returns an EnvironmentDescription list.
" - } - }, - "documentation":"Result message containing a list of environment descriptions.
" - }, - "EnvironmentHealth":{ - "type":"string", - "enum":[ - "Green", - "Yellow", - "Red", - "Grey" - ] - }, - "EnvironmentId":{"type":"string"}, - "EnvironmentIdList":{ - "type":"list", - "member":{"shape":"EnvironmentId"} - }, - "EnvironmentInfoDescription":{ - "type":"structure", - "members":{ - "InfoType":{ - "shape":"EnvironmentInfoType", - "documentation":"The type of information retrieved.
" - }, - "Ec2InstanceId":{ - "shape":"Ec2InstanceId", - "documentation":"The Amazon EC2 Instance ID for this information.
" - }, - "SampleTimestamp":{ - "shape":"SampleTimestamp", - "documentation":"The time stamp when this information was retrieved.
" - }, - "Message":{ - "shape":"Message", - "documentation":"The retrieved information.
" - } - }, - "documentation":"The information retrieved from the Amazon EC2 instances.
" - }, - "EnvironmentInfoDescriptionList":{ - "type":"list", - "member":{"shape":"EnvironmentInfoDescription"} - }, - "EnvironmentInfoType":{ - "type":"string", - "enum":["tail"] - }, - "EnvironmentName":{ - "type":"string", - "min":4, - "max":23 - }, - "EnvironmentNamesList":{ - "type":"list", - "member":{"shape":"EnvironmentName"} - }, - "EnvironmentResourceDescription":{ - "type":"structure", - "members":{ - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"The name of the environment.
" - }, - "AutoScalingGroups":{ - "shape":"AutoScalingGroupList", - "documentation":" The AutoScalingGroups used by this environment.
The Amazon EC2 instances used by this environment.
" - }, - "LaunchConfigurations":{ - "shape":"LaunchConfigurationList", - "documentation":"The Auto Scaling launch configurations in use by this environment.
" - }, - "LoadBalancers":{ - "shape":"LoadBalancerList", - "documentation":"The LoadBalancers in use by this environment.
" - }, - "Triggers":{ - "shape":"TriggerList", - "documentation":" The AutoScaling triggers in use by this environment.
The queues used by this environment.
" - } - }, - "documentation":"Describes the AWS resources in use by this environment. This data is live.
" - }, - "EnvironmentResourceDescriptionsMessage":{ - "type":"structure", - "members":{ - "EnvironmentResources":{ - "shape":"EnvironmentResourceDescription", - "documentation":"A list of EnvironmentResourceDescription.
" - } - }, - "documentation":"Result message containing a list of environment resource descriptions.
" - }, - "EnvironmentResourcesDescription":{ - "type":"structure", - "members":{ - "LoadBalancer":{ - "shape":"LoadBalancerDescription", - "documentation":"Describes the LoadBalancer.
" - } - }, - "documentation":"Describes the AWS resources in use by this environment. This data is not live data.
" - }, - "EnvironmentStatus":{ - "type":"string", - "enum":[ - "Launching", - "Updating", - "Ready", - "Terminating", - "Terminated" - ] - }, - "EnvironmentTier":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of this environment tier.
" - }, - "Type":{ - "shape":"String", - "documentation":"The type of this environment tier.
" - }, - "Version":{ - "shape":"String", - "documentation":"The version of this environment tier.
" - } - }, - "documentation":"Describes the properties of an environment tier
" - }, - "EventDate":{"type":"timestamp"}, - "EventDescription":{ - "type":"structure", - "members":{ - "EventDate":{ - "shape":"EventDate", - "documentation":"The date when the event occurred.
" - }, - "Message":{ - "shape":"EventMessage", - "documentation":"The event message.
" - }, - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The application associated with the event.
" - }, - "VersionLabel":{ - "shape":"VersionLabel", - "documentation":"The release label for the application version associated with this event.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration associated with this event.
" - }, - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"The name of the environment associated with this event.
" - }, - "RequestId":{ - "shape":"RequestId", - "documentation":"The web service request ID for the activity of this event.
" - }, - "Severity":{ - "shape":"EventSeverity", - "documentation":"The severity level of this event.
" - } - }, - "documentation":"Describes an event.
" - }, - "EventDescriptionList":{ - "type":"list", - "member":{"shape":"EventDescription"} - }, - "EventDescriptionsMessage":{ - "type":"structure", - "members":{ - "Events":{ - "shape":"EventDescriptionList", - "documentation":"A list of EventDescription.
" - }, - "NextToken":{ - "shape":"Token", - "documentation":"If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
" - } - }, - "documentation":"Result message wrapping a list of event descriptions.
" - }, - "EventMessage":{"type":"string"}, - "EventSeverity":{ - "type":"string", - "enum":[ - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL" - ] - }, - "FileTypeExtension":{ - "type":"string", - "min":1, - "max":100 - }, - "IncludeDeleted":{"type":"boolean"}, - "IncludeDeletedBackTo":{"type":"timestamp"}, - "Instance":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"ResourceId", - "documentation":"The ID of the Amazon EC2 instance.
" - } - }, - "documentation":"The description of an Amazon EC2 instance.
" - }, - "InstanceList":{ - "type":"list", - "member":{"shape":"Instance"} - }, - "InsufficientPrivilegesException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientPrivilegesException", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
" - }, - "Integer":{"type":"integer"}, - "LaunchConfiguration":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceId", - "documentation":"The name of the launch configuration.
" - } - }, - "documentation":"Describes an Auto Scaling launch configuration.
" - }, - "LaunchConfigurationList":{ - "type":"list", - "member":{"shape":"LaunchConfiguration"} - }, - "ListAvailableSolutionStacksResultMessage":{ - "type":"structure", - "members":{ - "SolutionStacks":{ - "shape":"AvailableSolutionStackNamesList", - "documentation":"A list of available solution stacks.
" - }, - "SolutionStackDetails":{ - "shape":"AvailableSolutionStackDetailsList", - "documentation":"A list of available solution stacks and their SolutionStackDescription.
" - } - }, - "documentation":"A list of available AWS Elastic Beanstalk solution stacks.
" - }, - "Listener":{ - "type":"structure", - "members":{ - "Protocol":{ - "shape":"String", - "documentation":"The protocol that is used by the Listener.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"The port that is used by the Listener.
" - } - }, - "documentation":"Describes the properties of a Listener for the LoadBalancer.
" - }, - "LoadBalancer":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceId", - "documentation":"The name of the LoadBalancer.
" - } - }, - "documentation":"Describes a LoadBalancer.
" - }, - "LoadBalancerDescription":{ - "type":"structure", - "members":{ - "LoadBalancerName":{ - "shape":"String", - "documentation":"The name of the LoadBalancer.
" - }, - "Domain":{ - "shape":"String", - "documentation":"The domain name of the LoadBalancer.
" - }, - "Listeners":{ - "shape":"LoadBalancerListenersDescription", - "documentation":"A list of Listeners used by the LoadBalancer.
" - } - }, - "documentation":"Describes the details of a LoadBalancer.
" - }, - "LoadBalancerList":{ - "type":"list", - "member":{"shape":"LoadBalancer"} - }, - "LoadBalancerListenersDescription":{ - "type":"list", - "member":{"shape":"Listener"} - }, - "MaxRecords":{ - "type":"integer", - "min":1, - "max":1000 - }, - "Message":{"type":"string"}, - "OperationInProgressException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OperationInProgressFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
" - }, - "OptionNamespace":{"type":"string"}, - "OptionRestrictionMaxLength":{"type":"integer"}, - "OptionRestrictionMaxValue":{"type":"integer"}, - "OptionRestrictionMinValue":{"type":"integer"}, - "OptionRestrictionRegex":{ - "type":"structure", - "members":{ - "Pattern":{ - "shape":"RegexPattern", - "documentation":"The regular expression pattern that a string configuration option value with this restriction must match.
" - }, - "Label":{ - "shape":"RegexLabel", - "documentation":"A unique name representing this regular expression.
" - } - }, - "documentation":"A regular expression representing a restriction on a string configuration option value.
" - }, - "OptionSpecification":{ - "type":"structure", - "members":{ - "Namespace":{ - "shape":"OptionNamespace", - "documentation":"A unique namespace identifying the option's associated AWS resource.
" - }, - "OptionName":{ - "shape":"ConfigurationOptionName", - "documentation":"The name of the configuration option.
" - } - }, - "documentation":"A specification identifying an individual configuration option.
" - }, - "OptionsSpecifierList":{ - "type":"list", - "member":{"shape":"OptionSpecification"} - }, - "Queue":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the queue.
" - }, - "URL":{ - "shape":"String", - "documentation":"The URL of the queue.
" - } - }, - "documentation":"Describes a queue.
" - }, - "QueueList":{ - "type":"list", - "member":{"shape":"Queue"} - }, - "RebuildEnvironmentMessage":{ - "type":"structure", - "members":{ - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The ID of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The type of information to request.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "RequestId":{"type":"string"}, - "ResourceId":{"type":"string"}, - "RestartAppServerMessage":{ - "type":"structure", - "members":{ - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The ID of the data's environment.
If no such environment is found, returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the data's environment.
If no such environment is found, returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The type of information to retrieve.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "RetrieveEnvironmentInfoResultMessage":{ - "type":"structure", - "members":{ - "EnvironmentInfo":{ - "shape":"EnvironmentInfoDescriptionList", - "documentation":"The EnvironmentInfoDescription of the environment.
" - } - }, - "documentation":"Result message containing a description of the requested environment info.
" - }, - "S3Bucket":{ - "type":"string", - "max":255 - }, - "S3Key":{ - "type":"string", - "max":1024 - }, - "S3Location":{ - "type":"structure", - "members":{ - "S3Bucket":{ - "shape":"S3Bucket", - "documentation":"The Amazon S3 bucket where the data is located.
" - }, - "S3Key":{ - "shape":"S3Key", - "documentation":"The Amazon S3 key where the data is located.
" - } - }, - "documentation":"A specification of a location in Amazon S3.
" - }, - "S3LocationNotInServiceRegionException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"S3LocationNotInServiceRegionException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified S3 bucket does not belong to the S3 region in which the service is running.
" - }, - "S3SubscriptionRequiredException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"S3SubscriptionRequiredException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller does not have a subscription to Amazon S3.
" - }, - "SampleTimestamp":{"type":"timestamp"}, - "SolutionStackDescription":{ - "type":"structure", - "members":{ - "SolutionStackName":{ - "shape":"SolutionStackName", - "documentation":"The name of the solution stack.
" - }, - "PermittedFileTypes":{ - "shape":"SolutionStackFileTypeList", - "documentation":"The permitted file types allowed for a solution stack.
" - } - }, - "documentation":"Describes the solution stack.
" - }, - "SolutionStackFileTypeList":{ - "type":"list", - "member":{"shape":"FileTypeExtension"} - }, - "SolutionStackName":{ - "type":"string", - "max":100 - }, - "SourceBundleDeletionException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SourceBundleDeletionFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Unable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.
" - }, - "SourceConfiguration":{ - "type":"structure", - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with the configuration.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration template.
" - } - }, - "documentation":"A specification for an environment configuration
" - }, - "String":{"type":"string"}, - "SwapEnvironmentCNAMEsMessage":{ - "type":"structure", - "members":{ - "SourceEnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of the source environment.
Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.
The name of the source environment.
Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.
The ID of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.
The name of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.
The key of the tag.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The value of the tag.
" - } - }, - "documentation":"Describes a tag applied to a resource in an environment.
" - }, - "TagKey":{ - "type":"string", - "min":1, - "max":128 - }, - "TagValue":{ - "type":"string", - "min":1, - "max":256 - }, - "Tags":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "TerminateEnvForce":{"type":"boolean"}, - "TerminateEnvironmentMessage":{ - "type":"structure", - "members":{ - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.
false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.
true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true | false
This documentation target is not reported in the API reference.
" - }, - "TerminateEnvironmentResources":{"type":"boolean"}, - "TimeFilterEnd":{"type":"timestamp"}, - "TimeFilterStart":{"type":"timestamp"}, - "Token":{"type":"string"}, - "TooManyApplicationVersionsException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The caller has exceeded the limit on the number of application versions associated with their account.
" - }, - "TooManyApplicationsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyApplicationsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit on the number of applications associated with their account.
" - }, - "TooManyBucketsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyBucketsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.
" - }, - "TooManyConfigurationTemplatesException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyConfigurationTemplatesException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit on the number of configuration templates associated with their account.
" - }, - "TooManyEnvironmentsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyEnvironmentsException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The caller has exceeded the limit of allowed environments associated with the account.
" - }, - "Trigger":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"ResourceId", - "documentation":"The name of the trigger.
" - } - }, - "documentation":"Describes a trigger.
" - }, - "TriggerList":{ - "type":"list", - "member":{"shape":"Trigger"} - }, - "UpdateApplicationMessage":{ - "type":"structure", - "required":["ApplicationName"], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":" The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.
A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "UpdateApplicationVersionMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "VersionLabel" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with this version.
If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.
The name of the version to update.
If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.
A new description for this release.
" - } - }, - "documentation":"" - }, - "UpdateConfigurationTemplateMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "TemplateName" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application associated with the configuration template to update.
If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
The name of the configuration template to update.
If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
A new description for the configuration.
" - }, - "OptionSettings":{ - "shape":"ConfigurationOptionSettingsList", - "documentation":"A list of configuration option settings to update with the new specified option value.
" - }, - "OptionsToRemove":{ - "shape":"OptionsSpecifierList", - "documentation":"A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined configuration options.
The result message containing the options for the specified solution stack.
" - }, - "UpdateDate":{"type":"timestamp"}, - "UpdateEnvironmentMessage":{ - "type":"structure", - "members":{ - "EnvironmentId":{ - "shape":"EnvironmentId", - "documentation":"The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
" - }, - "Tier":{ - "shape":"EnvironmentTier", - "documentation":"This specifies the tier to use to update the environment.
Condition: You can only update the tier version for an environment. If you change the name of the type, AWS Elastic Beanstalk returns InvalidParameterValue error.
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
" - }, - "OptionsToRemove":{ - "shape":"OptionsSpecifierList", - "documentation":"A list of custom user-defined configuration options to remove from the configuration set for this environment.
" - } - }, - "documentation":"This documentation target is not reported in the API reference.
" - }, - "UserDefinedOption":{"type":"boolean"}, - "ValidateConfigurationSettingsMessage":{ - "type":"structure", - "required":[ - "ApplicationName", - "OptionSettings" - ], - "members":{ - "ApplicationName":{ - "shape":"ApplicationName", - "documentation":"The name of the application that the configuration template or environment belongs to.
" - }, - "TemplateName":{ - "shape":"ConfigurationTemplateName", - "documentation":"The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
" - }, - "EnvironmentName":{ - "shape":"EnvironmentName", - "documentation":"The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
" - }, - "OptionSettings":{ - "shape":"ConfigurationOptionSettingsList", - "documentation":"A list of the options and desired values to evaluate.
" - } - }, - "documentation":"A list of validation messages for a specified configuration template.
" - }, - "ValidationMessage":{ - "type":"structure", - "members":{ - "Message":{ - "shape":"ValidationMessageString", - "documentation":"A message describing the error or warning.
" - }, - "Severity":{ - "shape":"ValidationSeverity", - "documentation":"An indication of the severity of this message:
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
An error or warning for a desired configuration option value.
" - }, - "ValidationMessageString":{"type":"string"}, - "ValidationMessagesList":{ - "type":"list", - "member":{"shape":"ValidationMessage"} - }, - "ValidationSeverity":{ - "type":"string", - "enum":[ - "error", - "warning" - ] - }, - "VersionLabel":{ - "type":"string", - "min":1, - "max":100 - }, - "VersionLabelsList":{ - "type":"list", - "member":{"shape":"VersionLabel"} - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/elasticbeanstalk/2010-12-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/elasticbeanstalk/2010-12-01.paginators.json deleted file mode 100644 index 350cce4dba..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/elasticbeanstalk/2010-12-01.paginators.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "pagination": { - "DescribeEvents": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxRecords", - "result_key": "Events" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/elastictranscoder/2012-09-25.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/elastictranscoder/2012-09-25.normal.json deleted file mode 100644 index 2637accf71..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/elastictranscoder/2012-09-25.normal.json +++ /dev/null @@ -1,2629 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-09-25", - "endpointPrefix":"elastictranscoder", - "serviceFullName":"Amazon Elastic Transcoder", - "signatureVersion":"v4", - "protocol":"rest-json" - }, - "documentation":"The AWS Elastic Transcoder Service.
", - "operations":{ - "CancelJob":{ - "name":"CancelJob", - "http":{ - "method":"DELETE", - "requestUri":"/2012-09-25/jobs/{Id}", - "responseCode":202 - }, - "input":{ - "shape":"CancelJobRequest", - "documentation":"The CancelJobRequest structure.
The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"ResourceInUseException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The CancelJob operation cancels an unfinished job.
Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.The CreateJobRequest structure.
The CreateJobResponse structure.
" - }, - "errors":[ - { - "shape":"ValidationException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.
If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).
" - }, - "CreatePipeline":{ - "name":"CreatePipeline", - "http":{ - "method":"POST", - "requestUri":"/2012-09-25/pipelines", - "responseCode":201 - }, - "input":{ - "shape":"CreatePipelineRequest", - "documentation":"The CreatePipelineRequest structure.
When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.
" - }, - "errors":[ - { - "shape":"ValidationException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The CreatePipeline operation creates a pipeline with settings that you specify.
" - }, - "CreatePreset":{ - "name":"CreatePreset", - "http":{ - "method":"POST", - "requestUri":"/2012-09-25/presets", - "responseCode":201 - }, - "input":{ - "shape":"CreatePresetRequest", - "documentation":"The CreatePresetRequest structure.
The CreatePresetResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The CreatePreset operation creates a preset with settings that you specify.
ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.
" - }, - "DeletePipeline":{ - "name":"DeletePipeline", - "http":{ - "method":"DELETE", - "requestUri":"/2012-09-25/pipelines/{Id}", - "responseCode":202 - }, - "input":{ - "shape":"DeletePipelineRequest", - "documentation":"The DeletePipelineRequest structure.
The DeletePipelineResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"ResourceInUseException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The DeletePipeline operation removes a pipeline.
You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.
The DeletePresetRequest structure.
The DeletePresetResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The DeletePreset operation removes a preset that you've added in an AWS region.
You can't delete the default presets that are included with Elastic Transcoder.
The ListJobsByPipelineRequest structure.
The ListJobsByPipelineResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.
" - }, - "ListJobsByStatus":{ - "name":"ListJobsByStatus", - "http":{ - "method":"GET", - "requestUri":"/2012-09-25/jobsByStatus/{Status}" - }, - "input":{ - "shape":"ListJobsByStatusRequest", - "documentation":"The ListJobsByStatusRequest structure.
The ListJobsByStatusResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.
" - }, - "ListPipelines":{ - "name":"ListPipelines", - "http":{ - "method":"GET", - "requestUri":"/2012-09-25/pipelines" - }, - "input":{ - "shape":"ListPipelinesRequest", - "documentation":"The ListPipelineRequest structure.
A list of the pipelines associated with the current AWS account.
" - }, - "errors":[ - { - "shape":"ValidationException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
" - }, - "ListPresets":{ - "name":"ListPresets", - "http":{ - "method":"GET", - "requestUri":"/2012-09-25/presets" - }, - "input":{ - "shape":"ListPresetsRequest", - "documentation":"The ListPresetsRequest structure.
The ListPresetsResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.
" - }, - "ReadJob":{ - "name":"ReadJob", - "http":{ - "method":"GET", - "requestUri":"/2012-09-25/jobs/{Id}" - }, - "input":{ - "shape":"ReadJobRequest", - "documentation":"The ReadJobRequest structure.
The ReadJobResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ReadJob operation returns detailed information about a job.
" - }, - "ReadPipeline":{ - "name":"ReadPipeline", - "http":{ - "method":"GET", - "requestUri":"/2012-09-25/pipelines/{Id}" - }, - "input":{ - "shape":"ReadPipelineRequest", - "documentation":"The ReadPipelineRequest structure.
The ReadPipelineResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ReadPipeline operation gets detailed information about a pipeline.
" - }, - "ReadPreset":{ - "name":"ReadPreset", - "http":{ - "method":"GET", - "requestUri":"/2012-09-25/presets/{Id}" - }, - "input":{ - "shape":"ReadPresetRequest", - "documentation":"The ReadPresetRequest structure.
The ReadPresetResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The ReadPreset operation gets detailed information about a preset.
" - }, - "TestRole":{ - "name":"TestRole", - "http":{ - "method":"POST", - "requestUri":"/2012-09-25/roleTests", - "responseCode":200 - }, - "input":{ - "shape":"TestRoleRequest", - "documentation":" The TestRoleRequest structure.
The TestRoleResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The TestRole operation tests the IAM role used to create the pipeline.
The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.
The UpdatePipelineRequest structure.
When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.
" - }, - "errors":[ - { - "shape":"ValidationException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"ResourceInUseException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":" Use the UpdatePipeline operation to update settings for a pipeline.
The UpdatePipelineNotificationsRequest structure.
The UpdatePipelineNotificationsResponse structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"ResourceInUseException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.
" - }, - "UpdatePipelineStatus":{ - "name":"UpdatePipelineStatus", - "http":{ - "method":"POST", - "requestUri":"/2012-09-25/pipelines/{Id}/status" - }, - "input":{ - "shape":"UpdatePipelineStatusRequest", - "documentation":"The UpdatePipelineStatusRequest structure.
One or more required parameter values were not provided in the request.
" - }, - { - "shape":"IncompatibleVersionException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - { - "shape":"ResourceInUseException", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
" - }, - { - "shape":"AccessDeniedException", - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - { - "shape":"InternalServiceException", - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - } - ], - "documentation":"The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.
Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.
" - } - }, - "shapes":{ - "AccessControl":{ - "type":"string", - "pattern":"(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)" - }, - "AccessControls":{ - "type":"list", - "member":{"shape":"AccessControl"}, - "max":30 - }, - "AccessDeniedException":{ - "type":"structure", - "members":{ - }, - "error":{"httpStatusCode":403}, - "exception":true, - "documentation":"General authentication failure. The request was not signed correctly.
" - }, - "Artwork":{ - "type":"structure", - "members":{ - "InputKey":{ - "shape":"WatermarkKey", - "documentation":"The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted.Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art.ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.
The format of album art, if any. Valid formats are .jpg and .png.
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
" - } - }, - "documentation":"The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.
To remove artwork or leave the artwork empty, you can either set Artwork to null, or set the Merge Policy to \"Replace\" and use an empty Artwork array.
To pass through existing artwork unchanged, set the Merge Policy to \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
auto: If you specify auto, Elastic Transcoder will select the profile based on the bit rate selected for the output file.AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps.HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps.All outputs in a Smooth playlist must have the same value for Profile.
If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.
Options associated with your audio codec.
" - }, - "AudioCodecProfile":{ - "type":"string", - "pattern":"(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)" - }, - "AudioParameters":{ - "type":"structure", - "members":{ - "Codec":{ - "shape":"AudioCodec", - "documentation":"The audio codec for the output file. Valid values include aac, mp3, and vorbis.
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
auto, 22050, 32000, 44100, 48000, 96000
If you specify auto, Elastic Transcoder automatically detects the sample rate.
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
" - }, - "Channels":{ - "shape":"AudioChannels", - "documentation":"The number of audio channels in the output file. Valid values include:
auto, 0, 1, 2
If you specify auto, Elastic Transcoder automatically detects the number of channels in the input file.
If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include:
auto, AAC-LC, HE-AAC, HE-AACv2
If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.
Parameters required for transcoding audio.
" - }, - "AudioSampleRate":{ - "type":"string", - "pattern":"(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)" - }, - "Base64EncodedString":{ - "type":"string", - "pattern":"^$|(^(?:[A-Za-z0-9\\+/]{4})*(?:[A-Za-z0-9\\+/]{2}==|[A-Za-z0-9\\+/]{3}=)?$)" - }, - "BucketName":{ - "type":"string", - "pattern":"^(\\w|\\.|-){1,255}$" - }, - "CancelJobRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"Id", - "location":"uri", - "locationName":"Id", - "documentation":"The identifier of the job that you want to cancel.
To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.
The CancelJobRequest structure.
The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.
The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
Valid Embedded Caption Formats:
For MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
For FMP4: dfxp
Non-FMP4 outputs: All sidecar types
fmp4 captions have an extension of .ismt
The prefix for caption filenames, in the form description-{language}, where:
{language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends \"{language}\" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter \"Sydney-{language}-sunrise\", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
" - }, - "Encryption":{ - "shape":"Encryption", - "documentation":"The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
" - } - }, - "documentation":"The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
" - }, - "CaptionFormatFormat":{ - "type":"string", - "pattern":"(^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)" - }, - "CaptionFormatPattern":{ - "type":"string", - "pattern":"(^$)|(^.*\\{language\\}.*$)" - }, - "CaptionFormats":{ - "type":"list", - "member":{"shape":"CaptionFormat"}, - "max":4 - }, - "CaptionMergePolicy":{ - "type":"string", - "pattern":"(^MergeOverride$)|(^MergeRetain$)|(^Override$)" - }, - "CaptionSource":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"Key", - "documentation":"The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
" - }, - "Language":{ - "shape":"Key", - "documentation":"A string that specifies the language of the caption. Specify this as one of:
2-character ISO 639-1 code
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
" - }, - "TimeOffset":{ - "shape":"TimeOffset", - "documentation":"For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
" - }, - "Label":{ - "shape":"Name", - "documentation":"The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
" - }, - "Encryption":{ - "shape":"Encryption", - "documentation":"The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
" - } - }, - "documentation":"A source file for the input sidecar captions used during the transcoding process.
" - }, - "CaptionSources":{ - "type":"list", - "member":{"shape":"CaptionSource"}, - "max":20 - }, - "Captions":{ - "type":"structure", - "members":{ - "MergePolicy":{ - "shape":"CaptionMergePolicy", - "documentation":"A policy that determines how Elastic Transcoder handles the existence of multiple captions.
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.
MergePolicy cannot be null.
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
" - } - }, - "documentation":"The captions to be created, if any.
" - }, - "Clip":{ - "type":"structure", - "members":{ - "TimeSpan":{ - "shape":"TimeSpan", - "documentation":"Settings that determine when a clip begins and how long it lasts.
" - } - }, - "documentation":"Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.
" - }, - "CodecOption":{ - "type":"string", - "min":1, - "max":255 - }, - "CodecOptions":{ - "type":"map", - "key":{"shape":"CodecOption"}, - "value":{"shape":"CodecOption"}, - "max":30 - }, - "Composition":{ - "type":"list", - "member":{"shape":"Clip"} - }, - "CreateJobOutput":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"Key", - "documentation":" The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify \"\".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.
{resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
{resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
" - }, - "Rotate":{ - "shape":"Rotate", - "documentation":" The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.
The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.
Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
" - }, - "AlbumArt":{ - "shape":"JobAlbumArt", - "documentation":"Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
" - }, - "Composition":{ - "shape":"Composition", - "documentation":"You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.
" - }, - "Captions":{ - "shape":"Captions", - "documentation":"You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt
Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
" - }, - "Encryption":{ - "shape":"Encryption", - "documentation":"You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.
" - } - }, - "documentation":"The CreateJobOutput structure.
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.
Note: Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.
The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:
OutputKeyPrefixOutputs:Key
If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
" - } - }, - "documentation":"Information about the master playlist.
" - }, - "CreateJobPlaylists":{ - "type":"list", - "member":{"shape":"CreateJobPlaylist"}, - "max":30 - }, - "CreateJobRequest":{ - "type":"structure", - "required":[ - "PipelineId", - "Input" - ], - "members":{ - "PipelineId":{ - "shape":"Id", - "documentation":"The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
A section of the request body that provides information about the file that is being transcoded.
" - }, - "Output":{"shape":"CreateJobOutput"}, - "Outputs":{ - "shape":"CreateJobOutputs", - "documentation":" A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
" - }, - "Playlists":{ - "shape":"CreateJobPlaylists", - "documentation":"If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
" - }, - "UserMetadata":{ - "shape":"UserMetadata", - "documentation":"User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs will be returned in the same order in which you specify them.
The CreateJobRequest structure.
A section of the response body that provides information about the job that is created.
" - } - }, - "documentation":"The CreateJobResponse structure.
" - }, - "CreatePipelineRequest":{ - "type":"structure", - "required":[ - "Name", - "InputBucket", - "Role" - ], - "members":{ - "Name":{ - "shape":"Name", - "documentation":"The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters.
" - }, - "InputBucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket in which you saved the media files that you want to transcode.
" - }, - "OutputBucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true:
OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
" - }, - "AwsKmsKeyArn":{ - "shape":"KeyArn", - "documentation":"The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.
If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.
Grantee object: Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. Grantee object is the registered email address of an AWS account.Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.
If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.
Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Grantee object is the registered email address of an AWS account. Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.The CreatePipelineRequest structure.
A section of the response body that provides information about the pipeline that is created.
" - } - }, - "documentation":"When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.
" - }, - "CreatePresetRequest":{ - "type":"structure", - "required":[ - "Name", - "Container" - ], - "members":{ - "Name":{ - "shape":"Name", - "documentation":"The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
" - }, - "Description":{ - "shape":"Description", - "documentation":"A description of the preset.
" - }, - "Container":{ - "shape":"PresetContainer", - "documentation":"The container type for the output file. Valid values include fmp4, mp3, mp4, ogg, ts, and webm.
A section of the request body that specifies the video parameters.
" - }, - "Audio":{ - "shape":"AudioParameters", - "documentation":"A section of the request body that specifies the audio parameters.
" - }, - "Thumbnails":{ - "shape":"Thumbnails", - "documentation":"A section of the request body that specifies the thumbnail parameters, if any.
" - } - }, - "documentation":"The CreatePresetRequest structure.
A section of the response body that provides information about the preset that is created.
" - }, - "Warning":{ - "shape":"String", - "documentation":"If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.
" - } - }, - "documentation":"The CreatePresetResponse structure.
The identifier of the pipeline that you want to delete.
" - } - }, - "documentation":"The DeletePipelineRequest structure.
The DeletePipelineResponse structure.
The identifier of the preset for which you want to get detailed information.
" - } - }, - "documentation":"The DeletePresetRequest structure.
The DeletePresetResponse structure.
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:
S3: Amazon S3 creates and manages the keys used for encrypting your files.
S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.
AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
AES-CTR: AES Counter Mode.
AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
Key
Key MD5
Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
The key must also be encrypted by using the Amazon Key Management Service.
" - }, - "KeyMd5":{ - "shape":"Base64EncodedString", - "documentation":"The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
" - }, - "InitializationVector":{ - "shape":"ZeroTo255String", - "documentation":"The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
" - } - }, - "documentation":"The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder will use to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.
" - }, - "EncryptionMode":{ - "type":"string", - "pattern":"(^s3$)|(^s3-aws-kms$)|(^aes-cbc-pkcs7$)|(^aes-ctr$)|(^aes-gcm$)" - }, - "ExceptionMessages":{ - "type":"list", - "member":{"shape":"String"} - }, - "Filename":{ - "type":"string", - "min":1, - "max":255 - }, - "FixedGOP":{ - "type":"string", - "pattern":"(^true$)|(^false$)" - }, - "Float":{ - "type":"string", - "pattern":"^\\d{1,5}(\\.\\d{0,5})?$" - }, - "FrameRate":{ - "type":"string", - "pattern":"(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" - }, - "Grantee":{ - "type":"string", - "min":1, - "max":255 - }, - "GranteeType":{ - "type":"string", - "pattern":"(^Canonical$)|(^Email$)|(^Group$)" - }, - "HlsContentProtection":{ - "type":"structure", - "members":{ - "Method":{ - "shape":"HlsContentProtectionMethod", - "documentation":"The content protection method for your output. The only valid value is: aes-128.
This value will be written into the method attribute of the EXT-X-KEY metadata tag in the output playlist.
If you want Elastic Transcoder to generate a key for you, leave this field blank.
If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
If Elastic Transcoder is generating your key for you, you must leave this field blank.
The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
" - }, - "InitializationVector":{ - "shape":"ZeroTo255String", - "documentation":"If Elastic Transcoder is generating your key for you, you must leave this field blank.
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
" - }, - "LicenseAcquisitionUrl":{ - "shape":"ZeroTo512String", - "documentation":"The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
" - }, - "KeyStoragePolicy":{ - "shape":"KeyStoragePolicy", - "documentation":"Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist.
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.
" - }, - "HlsContentProtectionMethod":{ - "type":"string", - "pattern":"(^aes-128$)" - }, - "HorizontalAlign":{ - "type":"string", - "pattern":"(^Left$)|(^Right$)|(^Center$)" - }, - "Id":{ - "type":"string", - "pattern":"^\\d{13}-\\w{6}$" - }, - "IncompatibleVersionException":{ - "type":"structure", - "members":{ - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "Interlaced":{ - "type":"string", - "pattern":"(^auto$)|(^true$)|(^false$)" - }, - "InternalServiceException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "fault":true, - "documentation":"Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
" - }, - "Job":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"Id", - "documentation":"The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
" - }, - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) for the job.
" - }, - "PipelineId":{ - "shape":"Id", - "documentation":" The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
A section of the request or response body that provides information about the file that is being transcoded.
" - }, - "Output":{ - "shape":"JobOutput", - "documentation":"If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
" - }, - "OutputKeyPrefix":{ - "shape":"Key", - "documentation":"The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
" - }, - "Status":{ - "shape":"JobStatus", - "documentation":" The status of the job: Submitted, Progressing, Complete, Canceled, or Error.
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs will be returned in the same order in which you specify them.
Metadata keys and values must use characters from the following list:
0-9
A-Z and a-z
Space
The following symbols: _.:/=+-%@
A section of the response body that provides information about the job that is created.
" - }, - "JobAlbumArt":{ - "type":"structure", - "members":{ - "MergePolicy":{ - "shape":"MergePolicy", - "documentation":"A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
Replace: The specified album art will replace any existing album art.Prepend: The specified album art will be placed in front of any existing album art.Append: The specified album art will be placed after any existing album art.Fallback: If the original input file contains artwork, Elastic Transcoder will use that artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the specified album art file.The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png
The .jpg or .png file associated with an audio file.
" - }, - "JobContainer":{ - "type":"string", - "pattern":"(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)" - }, - "JobInput":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"Key", - "documentation":" The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:
10, 15, 23.97, 24, 25, 29.97, 30, 60
If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.
This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:
1:1, 4:3, 3:2, 16:9
If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:
true, false
If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.
The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:
3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm
The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder will use to decrypt your file.
" - } - }, - "documentation":"Information about the file that you're transcoding.
" - }, - "JobOutput":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"String", - "documentation":"A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
" - }, - "Key":{ - "shape":"Key", - "documentation":" The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify \"\".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.
{resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job. Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
{resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
" - }, - "Rotate":{ - "shape":"Rotate", - "documentation":"The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:
auto, 0, 90, 180, 270
The value auto generally works only if the file that you're transcoding contains rotation metadata.
The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets.
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.
The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.
Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.
The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:
Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output.Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error.Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error. "
- },
- "StatusDetail":{
- "shape":"Description",
- "documentation":"Information that further explains Status.
Duration of the output file, in seconds.
" - }, - "Width":{ - "shape":"NullableInteger", - "documentation":"Specifies the width of the output file in pixels.
" - }, - "Height":{ - "shape":"NullableInteger", - "documentation":"Height of the output file, in pixels.
" - }, - "Watermarks":{ - "shape":"JobWatermarks", - "documentation":"Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
" - }, - "AlbumArt":{ - "shape":"JobAlbumArt", - "documentation":"The album art to be associated with the output file, if any.
" - }, - "Composition":{ - "shape":"Composition", - "documentation":"You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.
" - }, - "Captions":{ - "shape":"Captions", - "documentation":"You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt
Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
" - }, - "Encryption":{ - "shape":"Encryption", - "documentation":"The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder will write an unencrypted file to your Amazon S3 bucket.
" - } - }, - "documentation":"Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.
" - }, - "InputKey":{ - "shape":"WatermarkKey", - "documentation":" The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
" - }, - "Encryption":{ - "shape":"Encryption", - "documentation":"The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
" - } - }, - "documentation":"Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
" - }, - "JobWatermarks":{ - "type":"list", - "member":{"shape":"JobWatermark"} - }, - "Jobs":{ - "type":"list", - "member":{"shape":"Job"} - }, - "JpgOrPng":{ - "type":"string", - "pattern":"(^jpg$)|(^png$)" - }, - "Key":{ - "type":"string", - "min":1, - "max":255 - }, - "KeyArn":{ - "type":"string", - "min":0, - "max":255 - }, - "KeyStoragePolicy":{ - "type":"string", - "pattern":"(^NoStore$)|(^WithVariantPlaylists$)" - }, - "KeyframesMaxDist":{ - "type":"string", - "pattern":"^\\d{1,6}$" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - }, - "error":{"httpStatusCode":429}, - "exception":true, - "documentation":"Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
" - }, - "ListJobsByPipelineRequest":{ - "type":"structure", - "required":["PipelineId"], - "members":{ - "PipelineId":{ - "shape":"Id", - "location":"uri", - "locationName":"PipelineId", - "documentation":"The ID of the pipeline for which you want to get job information.
" - }, - "Ascending":{ - "shape":"Ascending", - "location":"querystring", - "locationName":"Ascending", - "documentation":" To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.
When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
The ListJobsByPipelineRequest structure.
An array of Job objects that are in the specified pipeline.
A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.
The ListJobsByPipelineResponse structure.
To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.
To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.
When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
The ListJobsByStatusRequest structure.
An array of Job objects that have the specified status.
A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.
The ListJobsByStatusResponse structure.
To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false.
When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
The ListPipelineRequest structure.
An array of Pipeline objects.
A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null.
A list of the pipelines associated with the current AWS account.
" - }, - "ListPresetsRequest":{ - "type":"structure", - "members":{ - "Ascending":{ - "shape":"Ascending", - "location":"querystring", - "locationName":"Ascending", - "documentation":"To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false.
When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
The ListPresetsRequest structure.
An array of Preset objects.
A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of NextPageToken is null.
The ListPresetsResponse structure.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
" - }, - "Completed":{ - "shape":"SnsTopic", - "documentation":"The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
" - }, - "Warning":{ - "shape":"SnsTopic", - "documentation":"The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
" - }, - "Error":{ - "shape":"SnsTopic", - "documentation":"The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
" - } - }, - "documentation":"The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
The type of value that appears in the Grantee object:
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Email: The registered email address of an AWS account.Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
" - }, - "Access":{ - "shape":"AccessControls", - "documentation":"The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.The Permission structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.
" - }, - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) for the pipeline.
" - }, - "Name":{ - "shape":"Name", - "documentation":"The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
" - }, - "Status":{ - "shape":"PipelineStatus", - "documentation":"The current status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.
" - }, - "OutputBucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.
" - }, - "AwsKmsKeyArn":{ - "shape":"KeyArn", - "documentation":"The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.
Grantee object: Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.Email: The registered email address of an AWS account.Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.Grantee: The AWS user or group that you want to have access to transcoded files and playlists.Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have. Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Email: The registered email address of an AWS account.Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.Grantee: The AWS user or group that you want to have access to thumbnail files.READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.The pipeline (queue) that is used to manage jobs.
" - }, - "PipelineOutputConfig":{ - "type":"structure", - "members":{ - "Bucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
ContentConfig and ThumbnailConfig instead. "
- },
- "StorageClass":{
- "shape":"StorageClass",
- "documentation":" The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.
If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
The PipelineOutputConfig structure.
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.
Note: Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.
The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:
OutputKeyPrefixOutputs:Key
If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
" - }, - "Status":{ - "shape":"JobStatus", - "documentation":"The status of the job with which the playlist is associated.
" - }, - "StatusDetail":{ - "shape":"Description", - "documentation":"Information that further explains the status.
" - } - }, - "documentation":" Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist per output format. The maximum number of master playlists in a job is 30.
Identifier for the new preset. You use this value to get settings for the preset or to delete it.
" - }, - "Arn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) for the preset.
" - }, - "Name":{ - "shape":"Name", - "documentation":"The name of the preset.
" - }, - "Description":{ - "shape":"Description", - "documentation":"A description of the preset.
" - }, - "Container":{ - "shape":"PresetContainer", - "documentation":"The container type for the output file. Valid values include fmp4, mp3, mp4, ogg, ts, and webm.
A section of the response body that provides information about the audio preset values.
" - }, - "Video":{ - "shape":"VideoParameters", - "documentation":"A section of the response body that provides information about the video preset values.
" - }, - "Thumbnails":{ - "shape":"Thumbnails", - "documentation":"A section of the response body that provides information about the thumbnail preset values, if any.
" - }, - "Type":{ - "shape":"PresetType", - "documentation":"Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom).
Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job.
" - }, - "PresetContainer":{ - "type":"string", - "pattern":"(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)|(^fmp4$)" - }, - "PresetType":{ - "type":"string", - "pattern":"(^System$)|(^Custom$)" - }, - "PresetWatermark":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"PresetWatermarkId", - "documentation":"A unique identifier for the settings for one watermark. The value ofId can be up to 40 characters long."
- },
- "MaxWidth":{
- "shape":"PixelsOrPercent",
- "documentation":"The maximum width of the watermark in one of the following formats:
MaxWidth.Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.MaxWidth.The maximum height of the watermark in one of the following formats:
MaxHeight.Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.MaxHeight."
- },
- "SizingPolicy":{
- "shape":"WatermarkSizingPolicy",
- "documentation":"A value that controls scaling of the watermark:
MaxWidth or MaxHeight without exceeding the other value.MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted.MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:
The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:
HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video. HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.
The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:
VerticalOffset The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:
MaxHeight.Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video. VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.
A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float.
Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency.
A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:
HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any.HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
" - }, - "PresetWatermarkId":{ - "type":"string", - "min":1, - "max":40 - }, - "PresetWatermarks":{ - "type":"list", - "member":{"shape":"PresetWatermark"} - }, - "Presets":{ - "type":"list", - "member":{"shape":"Preset"} - }, - "ReadJobRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"Id", - "location":"uri", - "locationName":"Id", - "documentation":"The identifier of the job for which you want to get detailed information.
" - } - }, - "documentation":"The ReadJobRequest structure.
A section of the response body that provides information about the job.
" - } - }, - "documentation":"The ReadJobResponse structure.
The identifier of the pipeline to read.
" - } - }, - "documentation":"The ReadPipelineRequest structure.
A section of the response body that provides information about the pipeline.
" - } - }, - "documentation":"The ReadPipelineResponse structure.
The identifier of the preset for which you want to get detailed information.
" - } - }, - "documentation":"The ReadPresetRequest structure.
A section of the response body that provides information about the preset.
" - } - }, - "documentation":"The ReadPresetResponse structure.
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
" - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
" - }, - "Role":{ - "type":"string", - "pattern":"^arn:aws:iam::\\w{12}:role/.+$" - }, - "Rotate":{ - "type":"string", - "pattern":"(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)" - }, - "SizingPolicy":{ - "type":"string", - "pattern":"(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)" - }, - "SnsTopic":{ - "type":"string", - "pattern":"(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)" - }, - "SnsTopics":{ - "type":"list", - "member":{"shape":"SnsTopic"}, - "max":30 - }, - "StorageClass":{ - "type":"string", - "pattern":"(^ReducedRedundancy$)|(^Standard$)" - }, - "String":{"type":"string"}, - "Success":{ - "type":"string", - "pattern":"(^true$)|(^false$)" - }, - "Target":{ - "type":"string", - "pattern":"(^Content$)|(^Frame$)" - }, - "TestRoleRequest":{ - "type":"structure", - "required":[ - "Role", - "InputBucket", - "OutputBucket", - "Topics" - ], - "members":{ - "Role":{ - "shape":"Role", - "documentation":"The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
" - }, - "InputBucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
" - }, - "OutputBucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.
" - }, - "Topics":{ - "shape":"SnsTopics", - "documentation":"The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
" - } - }, - "documentation":" The TestRoleRequest structure.
If the operation is successful, this value is true; otherwise, the value is false.
If the Success element contains false, this value is an array of one or more error messages that were generated during the test process.
The TestRoleResponse structure.
The format of thumbnails, if any. Valid values are jpg and png.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
" - }, - "Interval":{ - "shape":"Digits", - "documentation":"The approximate number of seconds between thumbnails. Specify an integer value.
" - }, - "Resolution":{ - "shape":"ThumbnailResolution", - "documentation":"To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto, 1:1, 4:3, 3:2, 16:9
If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
" - }, - "MaxHeight":{ - "shape":"DigitsOrAuto", - "documentation":"The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
" - }, - "SizingPolicy":{ - "shape":"SizingPolicy", - "documentation":"Specify one of the following values to control scaling of thumbnails:
Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.
Thumbnails for videos.
" - }, - "Time":{ - "type":"string", - "pattern":"(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)" - }, - "TimeOffset":{ - "type":"string", - "pattern":"(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)" - }, - "TimeSpan":{ - "type":"structure", - "members":{ - "StartTime":{ - "shape":"Time", - "documentation":"The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
" - }, - "Duration":{ - "shape":"Time", - "documentation":"The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
" - } - }, - "documentation":"Settings that determine when a clip begins and how long it lasts.
" - }, - "UpdatePipelineNotificationsRequest":{ - "type":"structure", - "required":[ - "Id", - "Notifications" - ], - "members":{ - "Id":{ - "shape":"Id", - "location":"uri", - "locationName":"Id", - "documentation":"The identifier of the pipeline for which you want to change notification settings.
" - }, - "Notifications":{ - "shape":"Notifications", - "documentation":"The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
The UpdatePipelineNotificationsRequest structure.
A section of the response body that provides information about the pipeline.
" - } - }, - "documentation":"The UpdatePipelineNotificationsResponse structure.
The ID of the pipeline that you want to update.
" - }, - "Name":{ - "shape":"Name", - "documentation":"The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
" - }, - "InputBucket":{ - "shape":"BucketName", - "documentation":"The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.
" - }, - "Role":{ - "shape":"Role", - "documentation":"The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.
" - }, - "AwsKmsKeyArn":{ - "shape":"KeyArn", - "documentation":"The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.
The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.
If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.
Grantee object: Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. Grantee object is the registered email address of an AWS account.Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.
If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.
Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. Grantee object is the registered email address of an AWS account. Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.The UpdatePipelineRequest structure.
When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.
" - }, - "UpdatePipelineStatusRequest":{ - "type":"structure", - "required":[ - "Id", - "Status" - ], - "members":{ - "Id":{ - "shape":"Id", - "location":"uri", - "locationName":"Id", - "documentation":"The identifier of the pipeline to update.
" - }, - "Status":{ - "shape":"PipelineStatus", - "documentation":"The desired status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.The UpdatePipelineStatusRequest structure.
A section of the response body that provides information about the pipeline.
" - } - }, - "documentation":"When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request." - }, - "UserMetadata":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "ValidationException":{ - "type":"structure", - "members":{ - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One or more required parameter values were not provided in the request.
" - }, - "VerticalAlign":{ - "type":"string", - "pattern":"(^Top$)|(^Bottom$)|(^Center$)" - }, - "VideoBitRate":{ - "type":"string", - "pattern":"(^\\d{2,5}$)|(^auto$)" - }, - "VideoCodec":{ - "type":"string", - "pattern":"(^H\\.264$)|(^vp8$)" - }, - "VideoParameters":{ - "type":"structure", - "members":{ - "Codec":{ - "shape":"VideoCodec", - "documentation":"The video codec for the output file. Valid values include H.264 and vp8. You can only specify vp8 when the container type is webm.
Profile
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
baseline: The profile most commonly used for videoconferencing and for mobile applications.main: The profile used for standard-definition digital TV broadcasts.high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)
where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the Level object. See the list below. (A macroblock is a block of pixels measuring 16x16.)
MaxBitRate
The maximum number of bits per second in a video buffer; the size of the buffer is specified by BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.
BufferSize
The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of MaxBitRate.
The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For Smooth outputs, the FrameRate must have a constant ratio to the KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels while the file is being played.
For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and 30, respectively.
Alternately, this can be achieved by setting FrameRate to auto and having the same values for MaxFrameRate and KeyframesMaxDist.
Whether to use a fixed value for FixedGOP. Valid values are true and false:
true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP).false: The distance between key frames can vary.FixedGOP must be set to true for fmp4 containers.
The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:
Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
The frames per second for the video stream in the output file. Valid values include:
auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60
If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:
Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)
where:
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60.
To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
The width and height of the video in the output file, in pixels. Valid values are auto and width x height:
auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.width x height: The width and height of the output video in pixels.Note the following about specifying the width and height:
To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
The display aspect ratio of the video in the output file. Valid values include:
auto, 1:1, 4:3, 3:2, 16:9
If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
" - }, - "MaxWidth":{ - "shape":"DigitsOrAuto", - "documentation":" The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.
The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.
The value that Elastic Transcoder adds to the metadata in the output file.
" - }, - "SizingPolicy":{ - "shape":"SizingPolicy", - "documentation":"Specify one of the following values to control scaling of the output video:
Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.Fill: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches the output video to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted.Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output video.ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight.
Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
" - } - }, - "documentation":"The VideoParameters structure.
Elastic Load Balancing is a way to automatically distribute incoming web traffic across applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances.
You can create, access, and manage Elastic Load Balancing using the AWS Management Console or the Elastic Load Balancing API. For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing.
This reference guide contains documentation for the Query API and the AWS command line interface commands, to manage Elastic Load Balancing.
For detailed information about Elastic Load Balancing features and their associated actions or commands, go to Managing Load Balancers in the Elastic Load Balancing Developer Guide.
This reference guide is based on the current WSDL, which is available at: .
Endpoints
The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference.
", - "operations":{ - "AddTags":{ - "name":"AddTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddTagsInput", - "documentation":"The input for the AddTags action" - }, - "output":{ - "shape":"AddTagsOutput", - "documentation":"The output for the AddTags action.", - "resultWrapper":"AddTagsResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"TooManyTagsException", - "error":{ - "code":"TooManyTags", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for the number of tags that can be assigned to a load balancer has been reached.
" - }, - { - "shape":"DuplicateTagKeysException", - "error":{ - "code":"DuplicateTagKeys", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The same tag key specified multiple times.
" - } - ], - "documentation":"Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value.
Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key.
For more information, see Tagging in the Elastic Load Balancing Developer Guide.
" - }, - "ApplySecurityGroupsToLoadBalancer":{ - "name":"ApplySecurityGroupsToLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ApplySecurityGroupsToLoadBalancerInput", - "documentation":"The input for the ApplySecurityGroupsToLoadBalancer action.
" - }, - "output":{ - "shape":"ApplySecurityGroupsToLoadBalancerOutput", - "documentation":"The out for the ApplySecurityGroupsToLoadBalancer action.
", - "resultWrapper":"ApplySecurityGroupsToLoadBalancerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - }, - { - "shape":"InvalidSecurityGroupException", - "error":{ - "code":"InvalidSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more specified security groups do not exist.
" - } - ], - "documentation":"Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups.
For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide.
" - }, - "AttachLoadBalancerToSubnets":{ - "name":"AttachLoadBalancerToSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AttachLoadBalancerToSubnetsInput", - "documentation":"The input for the AttachLoadBalancerToSubnets action.
" - }, - "output":{ - "shape":"AttachLoadBalancerToSubnetsOutput", - "documentation":"The output for the AttachLoadBalancerToSubnets action.
", - "resultWrapper":"AttachLoadBalancerToSubnetsResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - }, - { - "shape":"SubnetNotFoundException", - "error":{ - "code":"SubnetNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more subnets were not found.
" - }, - { - "shape":"InvalidSubnetException", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC has no Internet gateway.
" - } - ], - "documentation":"Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide.
" - }, - "ConfigureHealthCheck":{ - "name":"ConfigureHealthCheck", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ConfigureHealthCheckInput", - "documentation":"Input for the ConfigureHealthCheck action.
" - }, - "output":{ - "shape":"ConfigureHealthCheckOutput", - "documentation":"The output for the ConfigureHealthCheck action.
", - "resultWrapper":"ConfigureHealthCheckResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - } - ], - "documentation":"Specifies the health check settings to use for evaluating the health state of your back-end instances.
For more information, see Health Check in the Elastic Load Balancing Developer Guide.
" - }, - "CreateAppCookieStickinessPolicy":{ - "name":"CreateAppCookieStickinessPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateAppCookieStickinessPolicyInput", - "documentation":"The input for the CreateAppCookieStickinessPolicy action.
" - }, - "output":{ - "shape":"CreateAppCookieStickinessPolicyOutput", - "documentation":"The output for the CreateAppCookieStickinessPolicy action.
", - "resultWrapper":"CreateAppCookieStickinessPolicyResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"DuplicatePolicyNameException", - "error":{ - "code":"DuplicatePolicyName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Policy with the same name exists for this load balancer. Please choose another name.
" - }, - { - "shape":"TooManyPoliciesException", - "error":{ - "code":"TooManyPolicies", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Quota for number of policies for this load balancer has already been reached.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
AWSELB. This is the default behavior for many common web browsers. For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide.
" - }, - "CreateLBCookieStickinessPolicy":{ - "name":"CreateLBCookieStickinessPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateLBCookieStickinessPolicyInput", - "documentation":"The input for the CreateLBCookieStickinessPolicy action.
" - }, - "output":{ - "shape":"CreateLBCookieStickinessPolicyOutput", - "documentation":"The output for the CreateLBCookieStickinessPolicy action.
", - "resultWrapper":"CreateLBCookieStickinessPolicyResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"DuplicatePolicyNameException", - "error":{ - "code":"DuplicatePolicyName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Policy with the same name exists for this load balancer. Please choose another name.
" - }, - { - "shape":"TooManyPoliciesException", - "error":{ - "code":"TooManyPolicies", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Quota for number of policies for this load balancer has already been reached.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide.
" - }, - "CreateLoadBalancer":{ - "name":"CreateLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateAccessPointInput", - "documentation":"The input for the CreateLoadBalancer action.
" - }, - "output":{ - "shape":"CreateAccessPointOutput", - "documentation":"The output for the CreateLoadBalancer action.
", - "resultWrapper":"CreateLoadBalancerResult" - }, - "errors":[ - { - "shape":"DuplicateAccessPointNameException", - "error":{ - "code":"DuplicateLoadBalancerName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The load balancer name already exists for this account. Please choose another name.
" - }, - { - "shape":"TooManyAccessPointsException", - "error":{ - "code":"TooManyLoadBalancers", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for the number of load balancers has already been reached.
" - }, - { - "shape":"CertificateNotFoundException", - "error":{ - "code":"CertificateNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - }, - { - "shape":"SubnetNotFoundException", - "error":{ - "code":"SubnetNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more subnets were not found.
" - }, - { - "shape":"InvalidSubnetException", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC has no Internet gateway.
" - }, - { - "shape":"InvalidSecurityGroupException", - "error":{ - "code":"InvalidSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more specified security groups do not exist.
" - }, - { - "shape":"InvalidSchemeException", - "error":{ - "code":"InvalidScheme", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Invalid value for scheme. Scheme can only be specified for load balancers in VPC.
" - }, - { - "shape":"TooManyTagsException", - "error":{ - "code":"TooManyTags", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for the number of tags that can be assigned to a load balancer has been reached.
" - }, - { - "shape":"DuplicateTagKeysException", - "error":{ - "code":"DuplicateTagKeys", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The same tag key specified multiple times.
" - } - ], - "documentation":"Creates a new load balancer.
After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:
For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints.
You can create up to 20 load balancers per region per account.
Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:
For information on creating and managing your load balancers in EC2-Classic, see Deploy Elastic Load Balancing in Amazon EC2-Classic.
For information on creating and managing your load balancers in EC2-VPC, see Deploy Elastic Load Balancing in Amazon VPC.
The input for the CreateLoadBalancerListeners action.
" - }, - "output":{ - "shape":"CreateLoadBalancerListenerOutput", - "documentation":"The output for the CreateLoadBalancerListeners action.
", - "resultWrapper":"CreateLoadBalancerListenersResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"DuplicateListenerException", - "error":{ - "code":"DuplicateListener", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId.
The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide.
" - }, - "CreateLoadBalancerPolicy":{ - "name":"CreateLoadBalancerPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLoadBalancerPolicyInput"}, - "output":{ - "shape":"CreateLoadBalancerPolicyOutput", - "documentation":"The output for the CreateLoadBalancerPolicy action.
", - "resultWrapper":"CreateLoadBalancerPolicyResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"PolicyTypeNotFoundException", - "error":{ - "code":"PolicyTypeNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more of the specified policy types do not exist.
" - }, - { - "shape":"DuplicatePolicyNameException", - "error":{ - "code":"DuplicatePolicyName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Policy with the same name exists for this load balancer. Please choose another name.
" - }, - { - "shape":"TooManyPoliciesException", - "error":{ - "code":"TooManyPolicies", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Quota for number of policies for this load balancer has already been reached.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your load balancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type.
" - }, - "DeleteLoadBalancer":{ - "name":"DeleteLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteAccessPointInput", - "documentation":"The input for the DeleteLoadBalancer action.
" - }, - "output":{ - "shape":"DeleteAccessPointOutput", - "documentation":"The output for the DeleteLoadBalancer action.
", - "resultWrapper":"DeleteLoadBalancerResult" - }, - "documentation":"Deletes the specified load balancer.
If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances.
To successfully call this API, you must provide the same account credentials as were used to create the load balancer.
DeleteLoadBalancer action still succeeds. The input for the DeleteLoadBalancerListeners action.
" - }, - "output":{ - "shape":"DeleteLoadBalancerListenerOutput", - "documentation":"The output for the DeleteLoadBalancerListeners action.
", - "resultWrapper":"DeleteLoadBalancerListenersResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - } - ], - "documentation":"Deletes listeners from the load balancer for the specified port.
" - }, - "DeleteLoadBalancerPolicy":{ - "name":"DeleteLoadBalancerPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteLoadBalancerPolicyInput", - "documentation":"The input for the DeleteLoadBalancerPolicy action.
" - }, - "output":{ - "shape":"DeleteLoadBalancerPolicyOutput", - "documentation":"The output for the DeleteLoadBalancerPolicy action.
", - "resultWrapper":"DeleteLoadBalancerPolicyResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners.
" - }, - "DeregisterInstancesFromLoadBalancer":{ - "name":"DeregisterInstancesFromLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeregisterEndPointsInput", - "documentation":"The input for the DeregisterInstancesFromLoadBalancer action.
" - }, - "output":{ - "shape":"DeregisterEndPointsOutput", - "documentation":"The output for the DeregisterInstancesFromLoadBalancer action.
", - "resultWrapper":"DeregisterInstancesFromLoadBalancerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidEndPointException", - "error":{ - "code":"InvalidInstance", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified EndPoint is not valid.
" - } - ], - "documentation":"Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.
In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.
You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.
" - }, - "DescribeInstanceHealth":{ - "name":"DescribeInstanceHealth", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEndPointStateInput", - "documentation":"The input for the DescribeEndPointState action.
" - }, - "output":{ - "shape":"DescribeEndPointStateOutput", - "documentation":"The output for the DescribeInstanceHealth action.
", - "resultWrapper":"DescribeInstanceHealthResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidEndPointException", - "error":{ - "code":"InvalidInstance", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified EndPoint is not valid.
" - } - ], - "documentation":"Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned.
The input for the DescribeLoadBalancerAttributes action.
" - }, - "output":{ - "shape":"DescribeLoadBalancerAttributesOutput", - "documentation":"The following element is returned in a structure named DescribeLoadBalancerAttributesResult.
The specified load balancer could not be found.
" - }, - { - "shape":"LoadBalancerAttributeNotFoundException", - "error":{ - "code":"LoadBalancerAttributeNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer attribute could not be found.
" - } - ], - "documentation":"Returns detailed information about all of the attributes associated with the specified load balancer.
" - }, - "DescribeLoadBalancerPolicies":{ - "name":"DescribeLoadBalancerPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLoadBalancerPoliciesInput"}, - "output":{ - "shape":"DescribeLoadBalancerPoliciesOutput", - "documentation":"The output for the DescribeLoadBalancerPolicies action.
", - "resultWrapper":"DescribeLoadBalancerPoliciesResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"PolicyNotFoundException", - "error":{ - "code":"PolicyNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more specified policies were not found.
" - } - ], - "documentation":"Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.
The output for the DescribeLoadBalancerPolicyTypes action.
", - "resultWrapper":"DescribeLoadBalancerPolicyTypesResult" - }, - "errors":[ - { - "shape":"PolicyTypeNotFoundException", - "error":{ - "code":"PolicyTypeNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more of the specified policy types do not exist.
" - } - ], - "documentation":"Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer.
" - }, - "DescribeLoadBalancers":{ - "name":"DescribeLoadBalancers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeAccessPointsInput", - "documentation":"The input for the DescribeLoadBalancers action.
" - }, - "output":{ - "shape":"DescribeAccessPointsOutput", - "documentation":"The output for the DescribeLoadBalancers action.
", - "resultWrapper":"DescribeLoadBalancersResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - } - ], - "documentation":"Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.
The input for the DescribeTags action.
" - }, - "output":{ - "shape":"DescribeTagsOutput", - "documentation":"The output for the DescribeTags action.
", - "resultWrapper":"DescribeTagsResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - } - ], - "documentation":"Describes the tags associated with one or more load balancers.
" - }, - "DetachLoadBalancerFromSubnets":{ - "name":"DetachLoadBalancerFromSubnets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DetachLoadBalancerFromSubnetsInput", - "documentation":"The input for the DetachLoadBalancerFromSubnets action.
" - }, - "output":{ - "shape":"DetachLoadBalancerFromSubnetsOutput", - "documentation":"The output for the DetachLoadBalancerFromSubnets action.
", - "resultWrapper":"DetachLoadBalancerFromSubnetsResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer.
" - }, - "DisableAvailabilityZonesForLoadBalancer":{ - "name":"DisableAvailabilityZonesForLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveAvailabilityZonesInput", - "documentation":"The input for the DisableAvailabilityZonesForLoadBalancer action.
" - }, - "output":{ - "shape":"RemoveAvailabilityZonesOutput", - "documentation":"The output for the DisableAvailabilityZonesForLoadBalancer action.
", - "resultWrapper":"DisableAvailabilityZonesForLoadBalancerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.
There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.
" - }, - "EnableAvailabilityZonesForLoadBalancer":{ - "name":"EnableAvailabilityZonesForLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddAvailabilityZonesInput", - "documentation":"The input for the EnableAvailabilityZonesForLoadBalancer action.
" - }, - "output":{ - "shape":"AddAvailabilityZonesOutput", - "documentation":"The output for the EnableAvailabilityZonesForLoadBalancer action.
", - "resultWrapper":"EnableAvailabilityZonesForLoadBalancerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - } - ], - "documentation":"Adds one or more EC2 Availability Zones to the load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide.
" - }, - "ModifyLoadBalancerAttributes":{ - "name":"ModifyLoadBalancerAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyLoadBalancerAttributesInput", - "documentation":"The input for the ModifyLoadBalancerAttributes action.
" - }, - "output":{ - "shape":"ModifyLoadBalancerAttributesOutput", - "documentation":"The output for the ModifyLoadBalancerAttributes action.
", - "resultWrapper":"ModifyLoadBalancerAttributesResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"LoadBalancerAttributeNotFoundException", - "error":{ - "code":"LoadBalancerAttributeNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer attribute could not be found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Modifies the attributes of a specified load balancer.
You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.
For more information, see the following:
" - }, - "RegisterInstancesWithLoadBalancer":{ - "name":"RegisterInstancesWithLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RegisterEndPointsInput", - "documentation":"The input for the RegisterInstancesWithLoadBalancer action.
" - }, - "output":{ - "shape":"RegisterEndPointsOutput", - "documentation":"The output for the RegisterInstancesWithLoadBalancer action.
", - "resultWrapper":"RegisterInstancesWithLoadBalancerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"InvalidEndPointException", - "error":{ - "code":"InvalidInstance", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified EndPoint is not valid.
" - } - ], - "documentation":"Adds new instances to the load balancer.
Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer.
When an instance registered with a load balancer is stopped and then restarted, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.
You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.
" - }, - "RemoveTags":{ - "name":"RemoveTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveTagsInput", - "documentation":"The input for the RemoveTags action.
" - }, - "output":{ - "shape":"RemoveTagsOutput", - "documentation":"The output for the RemoveTags action.
", - "resultWrapper":"RemoveTagsResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - } - ], - "documentation":"Removes one or more tags from the specified load balancer.
" - }, - "SetLoadBalancerListenerSSLCertificate":{ - "name":"SetLoadBalancerListenerSSLCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetLoadBalancerListenerSSLCertificateInput", - "documentation":"The input for the SetLoadBalancerListenerSSLCertificate action.
" - }, - "output":{ - "shape":"SetLoadBalancerListenerSSLCertificateOutput", - "documentation":"The output for the SetLoadBalancerListenerSSLCertificate action.
", - "resultWrapper":"SetLoadBalancerListenerSSLCertificateResult" - }, - "errors":[ - { - "shape":"CertificateNotFoundException", - "error":{ - "code":"CertificateNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.
" - }, - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"ListenerNotFoundException", - "error":{ - "code":"ListenerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Load balancer does not have a listener configured at the given port.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide.
" - }, - "SetLoadBalancerPoliciesForBackendServer":{ - "name":"SetLoadBalancerPoliciesForBackendServer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetLoadBalancerPoliciesForBackendServerInput", - "documentation":"The input for the SetLoadBalancerPoliciesForBackendServer action.
" - }, - "output":{ - "shape":"SetLoadBalancerPoliciesForBackendServerOutput", - "documentation":"The output for the SetLoadBalancerPoliciesForBackendServer action.
", - "resultWrapper":"SetLoadBalancerPoliciesForBackendServerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"PolicyNotFoundException", - "error":{ - "code":"PolicyNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more specified policies were not found.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.
The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.
" - }, - "SetLoadBalancerPoliciesOfListener":{ - "name":"SetLoadBalancerPoliciesOfListener", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetLoadBalancerPoliciesOfListenerInput", - "documentation":"The input for the SetLoadBalancerPoliciesOfListener action.
" - }, - "output":{ - "shape":"SetLoadBalancerPoliciesOfListenerOutput", - "documentation":"The output for the SetLoadBalancerPoliciesOfListener action.
", - "resultWrapper":"SetLoadBalancerPoliciesOfListenerResult" - }, - "errors":[ - { - "shape":"AccessPointNotFoundException", - "error":{ - "code":"LoadBalancerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer could not be found.
" - }, - { - "shape":"PolicyNotFoundException", - "error":{ - "code":"PolicyNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more specified policies were not found.
" - }, - { - "shape":"ListenerNotFoundException", - "error":{ - "code":"ListenerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Load balancer does not have a listener configured at the given port.
" - }, - { - "shape":"InvalidConfigurationRequestException", - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - } - ], - "documentation":"Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener.
" - } - }, - "shapes":{ - "AccessLog":{ - "type":"structure", - "required":["Enabled"], - "members":{ - "Enabled":{ - "shape":"AccessLogEnabled", - "documentation":"Specifies whether access log is enabled for the load balancer.
" - }, - "S3BucketName":{ - "shape":"S3BucketName", - "documentation":"The name of the Amazon S3 bucket where the access logs are stored.
" - }, - "EmitInterval":{ - "shape":"AccessLogInterval", - "documentation":"The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
Default: 60 minutes
" - }, - "S3BucketPrefix":{ - "shape":"AccessLogPrefix", - "documentation":"The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.
The AccessLog data type.
The specified load balancer could not be found.
" - }, - "AccessPointPort":{"type":"integer"}, - "AddAvailabilityZonesInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "AvailabilityZones" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer.
" - } - }, - "documentation":"The input for the EnableAvailabilityZonesForLoadBalancer action.
" - }, - "AddAvailabilityZonesOutput":{ - "type":"structure", - "members":{ - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"An updated list of Availability Zones for the load balancer.
" - } - }, - "documentation":"The output for the EnableAvailabilityZonesForLoadBalancer action.
" - }, - "AddTagsInput":{ - "type":"structure", - "required":[ - "LoadBalancerNames", - "Tags" - ], - "members":{ - "LoadBalancerNames":{ - "shape":"LoadBalancerNames", - "documentation":"The name of the load balancer to tag. You can specify a maximum of one load balancer name.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tags for each load balancer.
" - } - }, - "documentation":"The input for the AddTags action" - }, - "AddTagsOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the AddTags action." - }, - "AdditionalAttribute":{ - "type":"structure", - "members":{ - "Key":{"shape":"StringVal"}, - "Value":{"shape":"StringVal"} - } - }, - "AdditionalAttributes":{ - "type":"list", - "member":{"shape":"AdditionalAttribute"} - }, - "AppCookieStickinessPolicies":{ - "type":"list", - "member":{"shape":"AppCookieStickinessPolicy"} - }, - "AppCookieStickinessPolicy":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"PolicyName", - "documentation":"The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
" - }, - "CookieName":{ - "shape":"CookieName", - "documentation":"The name of the application cookie used for stickiness.
" - } - }, - "documentation":"The AppCookieStickinessPolicy data type.
" - }, - "ApplySecurityGroupsToLoadBalancerInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "SecurityGroups" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"A list of security group IDs to associate with your load balancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234).
" - } - }, - "documentation":"The input for the ApplySecurityGroupsToLoadBalancer action.
" - }, - "ApplySecurityGroupsToLoadBalancerOutput":{ - "type":"structure", - "members":{ - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"A list of security group IDs associated with your load balancer.
" - } - }, - "documentation":"The out for the ApplySecurityGroupsToLoadBalancer action.
" - }, - "AttachLoadBalancerToSubnetsInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "Subnets" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.
" - }, - "Subnets":{ - "shape":"Subnets", - "documentation":"A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone.
" - } - }, - "documentation":"The input for the AttachLoadBalancerToSubnets action.
" - }, - "AttachLoadBalancerToSubnetsOutput":{ - "type":"structure", - "members":{ - "Subnets":{ - "shape":"Subnets", - "documentation":"A list of subnet IDs attached to the load balancer.
" - } - }, - "documentation":"The output for the AttachLoadBalancerToSubnets action.
" - }, - "AttributeName":{"type":"string"}, - "AttributeType":{"type":"string"}, - "AttributeValue":{"type":"string"}, - "AvailabilityZone":{"type":"string"}, - "AvailabilityZones":{ - "type":"list", - "member":{"shape":"AvailabilityZone"} - }, - "BackendServerDescription":{ - "type":"structure", - "members":{ - "InstancePort":{ - "shape":"InstancePort", - "documentation":"Provides the port on which the back-end server is listening.
" - }, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"Provides a list of policy names enabled for the back-end server.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server.
" - }, - "BackendServerDescriptions":{ - "type":"list", - "member":{"shape":"BackendServerDescription"} - }, - "Cardinality":{"type":"string"}, - "CertificateNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CertificateNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service.
" - }, - "ConfigureHealthCheckInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "HealthCheck" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account.
" - }, - "HealthCheck":{ - "shape":"HealthCheck", - "documentation":"A structure containing the configuration information for the new healthcheck.
" - } - }, - "documentation":"Input for the ConfigureHealthCheck action.
" - }, - "ConfigureHealthCheckOutput":{ - "type":"structure", - "members":{ - "HealthCheck":{ - "shape":"HealthCheck", - "documentation":"The updated healthcheck for the instances.
" - } - }, - "documentation":"The output for the ConfigureHealthCheck action.
" - }, - "ConnectionDraining":{ - "type":"structure", - "required":["Enabled"], - "members":{ - "Enabled":{ - "shape":"ConnectionDrainingEnabled", - "documentation":"Specifies whether connection draining is enabled for the load balancer.
" - }, - "Timeout":{ - "shape":"ConnectionDrainingTimeout", - "documentation":"Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.
" - } - }, - "documentation":"The ConnectionDraining data type.
Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.
" - } - }, - "documentation":"The ConnectionSettings data type.
The name associated with the load balancer. The name must be unique within your set of load balancers, must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens.
" - }, - "Listeners":{ - "shape":"Listeners", - "documentation":"A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"A list of Availability Zones.
At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones.
You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer action.
" - }, - "Subnets":{ - "shape":"Subnets", - "documentation":"A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"The security groups to assign to your load balancer within your VPC.
" - }, - "Scheme":{ - "shape":"LoadBalancerScheme", - "documentation":"The type of a load balancer.
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers.
Specify the value internal for this option to create an internal load balancer with a DNS name that resolves to private IP addresses.
This option is only available for load balancers created within EC2-VPC.
A list of tags to assign to the load balancer.
For more information about setting tags for your load balancer, see Tagging.
" - } - }, - "documentation":"The input for the CreateLoadBalancer action.
" - }, - "CreateAccessPointOutput":{ - "type":"structure", - "members":{ - "DNSName":{ - "shape":"DNSName", - "documentation":"The DNS name for the load balancer.
" - } - }, - "documentation":"The output for the CreateLoadBalancer action.
" - }, - "CreateAppCookieStickinessPolicyInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "PolicyName", - "CookieName" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "PolicyName":{ - "shape":"PolicyName", - "documentation":"The name of the policy being created. The name must be unique within the set of policies for this load balancer.
" - }, - "CookieName":{ - "shape":"CookieName", - "documentation":"Name of the application cookie used for stickiness.
" - } - }, - "documentation":"The input for the CreateAppCookieStickinessPolicy action.
" - }, - "CreateAppCookieStickinessPolicyOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the CreateAppCookieStickinessPolicy action.
" - }, - "CreateLBCookieStickinessPolicyInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "PolicyName" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer.
" - }, - "PolicyName":{ - "shape":"PolicyName", - "documentation":"The name of the policy being created. The name must be unique within the set of policies for this load balancer.
" - }, - "CookieExpirationPeriod":{ - "shape":"CookieExpirationPeriod", - "documentation":"The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.
" - } - }, - "documentation":"The input for the CreateLBCookieStickinessPolicy action.
" - }, - "CreateLBCookieStickinessPolicyOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the CreateLBCookieStickinessPolicy action.
" - }, - "CreateLoadBalancerListenerInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "Listeners" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "Listeners":{ - "shape":"Listeners", - "documentation":" A list of LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and SSLCertificateId items.
The input for the CreateLoadBalancerListeners action.
" - }, - "CreateLoadBalancerListenerOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the CreateLoadBalancerListeners action.
" - }, - "CreateLoadBalancerPolicyInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "PolicyName", - "PolicyTypeName" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the LoadBalancer for which the policy is being created.
" - }, - "PolicyName":{ - "shape":"PolicyName", - "documentation":"The name of the load balancer policy being created. The name must be unique within the set of policies for this load balancer.
" - }, - "PolicyTypeName":{ - "shape":"PolicyTypeName", - "documentation":"The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes action.
" - }, - "PolicyAttributes":{ - "shape":"PolicyAttributes", - "documentation":"A list of attributes associated with the policy being created.
" - } - } - }, - "CreateLoadBalancerPolicyOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the CreateLoadBalancerPolicy action.
" - }, - "CreatedTime":{"type":"timestamp"}, - "CrossZoneLoadBalancing":{ - "type":"structure", - "required":["Enabled"], - "members":{ - "Enabled":{ - "shape":"CrossZoneLoadBalancingEnabled", - "documentation":"Specifies whether cross-zone load balancing is enabled for the load balancer.
" - } - }, - "documentation":"The CrossZoneLoadBalancing data type.
The name associated with the load balancer.
" - } - }, - "documentation":"The input for the DeleteLoadBalancer action.
" - }, - "DeleteAccessPointOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the DeleteLoadBalancer action.
" - }, - "DeleteLoadBalancerListenerInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "LoadBalancerPorts" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The mnemonic name associated with the load balancer.
" - }, - "LoadBalancerPorts":{ - "shape":"Ports", - "documentation":"The client port number(s) of the load balancer listener(s) to be removed.
" - } - }, - "documentation":"The input for the DeleteLoadBalancerListeners action.
" - }, - "DeleteLoadBalancerListenerOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the DeleteLoadBalancerListeners action.
" - }, - "DeleteLoadBalancerPolicyInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "PolicyName" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The mnemonic name associated with the load balancer.
" - }, - "PolicyName":{ - "shape":"PolicyName", - "documentation":"The mnemonic name for the policy being deleted.
" - } - }, - "documentation":"The input for the DeleteLoadBalancerPolicy action.
" - }, - "DeleteLoadBalancerPolicyOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the DeleteLoadBalancerPolicy action.
" - }, - "DeregisterEndPointsInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "Instances" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer.
" - }, - "Instances":{ - "shape":"Instances", - "documentation":"A list of EC2 instance IDs consisting of all instances to be deregistered.
" - } - }, - "documentation":"The input for the DeregisterInstancesFromLoadBalancer action.
" - }, - "DeregisterEndPointsOutput":{ - "type":"structure", - "members":{ - "Instances":{ - "shape":"Instances", - "documentation":"An updated list of remaining instances registered with the load balancer.
" - } - }, - "documentation":"The output for the DeregisterInstancesFromLoadBalancer action.
" - }, - "DescribeAccessPointsInput":{ - "type":"structure", - "members":{ - "LoadBalancerNames":{ - "shape":"LoadBalancerNames", - "documentation":"A list of load balancer names associated with the account.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"An optional parameter used for pagination of results from this call. If specified, the response includes only records beyond the marker.
" - }, - "PageSize":{ - "shape":"PageSize", - "documentation":"The number of results returned in each page. The default is 400. You cannot specify a page size greater than 400 or less than 1.
" - } - }, - "documentation":"The input for the DescribeLoadBalancers action.
" - }, - "DescribeAccessPointsOutput":{ - "type":"structure", - "members":{ - "LoadBalancerDescriptions":{ - "shape":"LoadBalancerDescriptions", - "documentation":"A list of load balancer description structures.
" - }, - "NextMarker":{ - "shape":"Marker", - "documentation":"Specifies the value of next marker if the request returned more than one page of results.
" - } - }, - "documentation":"The output for the DescribeLoadBalancers action.
" - }, - "DescribeEndPointStateInput":{ - "type":"structure", - "required":["LoadBalancerName"], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "Instances":{ - "shape":"Instances", - "documentation":"A list of instance IDs whose states are being queried.
" - } - }, - "documentation":"The input for the DescribeEndPointState action.
" - }, - "DescribeEndPointStateOutput":{ - "type":"structure", - "members":{ - "InstanceStates":{ - "shape":"InstanceStates", - "documentation":"A list containing health information for the specified instances.
" - } - }, - "documentation":"The output for the DescribeInstanceHealth action.
" - }, - "DescribeLoadBalancerAttributesInput":{ - "type":"structure", - "required":["LoadBalancerName"], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - } - }, - "documentation":"The input for the DescribeLoadBalancerAttributes action.
" - }, - "DescribeLoadBalancerAttributesOutput":{ - "type":"structure", - "members":{ - "LoadBalancerAttributes":{ - "shape":"LoadBalancerAttributes", - "documentation":"The load balancer attributes structure.
" - } - }, - "documentation":"The following element is returned in a structure named DescribeLoadBalancerAttributesResult.
The mnemonic name associated with the load balancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.
" - }, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"The names of load balancer policies you've created or Elastic Load Balancing sample policy names.
" - } - } - }, - "DescribeLoadBalancerPoliciesOutput":{ - "type":"structure", - "members":{ - "PolicyDescriptions":{ - "shape":"PolicyDescriptions", - "documentation":"A list of policy description structures.
" - } - }, - "documentation":"The output for the DescribeLoadBalancerPolicies action.
" - }, - "DescribeLoadBalancerPolicyTypesInput":{ - "type":"structure", - "members":{ - "PolicyTypeNames":{ - "shape":"PolicyTypeNames", - "documentation":"Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.
" - } - } - }, - "DescribeLoadBalancerPolicyTypesOutput":{ - "type":"structure", - "members":{ - "PolicyTypeDescriptions":{ - "shape":"PolicyTypeDescriptions", - "documentation":"List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service.
" - } - }, - "documentation":"The output for the DescribeLoadBalancerPolicyTypes action.
" - }, - "DescribeTagsInput":{ - "type":"structure", - "required":["LoadBalancerNames"], - "members":{ - "LoadBalancerNames":{ - "shape":"LoadBalancerNamesMax20", - "documentation":"The names of the load balancers.
" - } - }, - "documentation":"The input for the DescribeTags action.
" - }, - "DescribeTagsOutput":{ - "type":"structure", - "members":{ - "TagDescriptions":{ - "shape":"TagDescriptions", - "documentation":"A list of tag description structures.
" - } - }, - "documentation":"The output for the DescribeTags action.
" - }, - "Description":{"type":"string"}, - "DetachLoadBalancerFromSubnetsInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "Subnets" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer to be detached.
" - }, - "Subnets":{ - "shape":"Subnets", - "documentation":"A list of subnet IDs to remove from the set of configured subnets for the load balancer.
" - } - }, - "documentation":"The input for the DetachLoadBalancerFromSubnets action.
" - }, - "DetachLoadBalancerFromSubnetsOutput":{ - "type":"structure", - "members":{ - "Subnets":{ - "shape":"Subnets", - "documentation":"A list of subnet IDs the load balancer is now attached to.
" - } - }, - "documentation":"The output for the DetachLoadBalancerFromSubnets action.
" - }, - "DuplicateAccessPointNameException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DuplicateLoadBalancerName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The load balancer name already exists for this account. Please choose another name.
" - }, - "DuplicateListenerException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DuplicateListener", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId.
Policy with the same name exists for this load balancer. Please choose another name.
" - }, - "DuplicateTagKeysException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DuplicateTagKeys", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The same tag key specified multiple times.
" - }, - "EndPointPort":{"type":"integer"}, - "HealthCheck":{ - "type":"structure", - "required":[ - "Target", - "Interval", - "Timeout", - "UnhealthyThreshold", - "HealthyThreshold" - ], - "members":{ - "Target":{ - "shape":"HealthCheckTarget", - "documentation":"Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Specifies the approximate interval, in seconds, between health checks of an individual instance.
" - }, - "Timeout":{ - "shape":"HealthCheckTimeout", - "documentation":"Specifies the amount of time, in seconds, during which no response means a failed health probe.
Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.
" - }, - "HealthyThreshold":{ - "shape":"HealthyThreshold", - "documentation":"Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.
" - } - }, - "documentation":"The HealthCheck data type.
" - }, - "HealthCheckInterval":{ - "type":"integer", - "min":1, - "max":300 - }, - "HealthCheckTarget":{"type":"string"}, - "HealthCheckTimeout":{ - "type":"integer", - "min":1, - "max":300 - }, - "HealthyThreshold":{ - "type":"integer", - "min":2, - "max":10 - }, - "IdleTimeout":{ - "type":"integer", - "min":1, - "max":3600 - }, - "Instance":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"InstanceId", - "documentation":"Provides an EC2 instance ID.
" - } - }, - "documentation":"The Instance data type.
" - }, - "InstanceId":{"type":"string"}, - "InstancePort":{ - "type":"integer", - "min":1, - "max":65535 - }, - "InstanceState":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"InstanceId", - "documentation":"Provides an EC2 instance ID.
" - }, - "State":{ - "shape":"State", - "documentation":"Specifies the current state of the instance.
Valid value: InService|OutOfService|Unknown
Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the load balancer.
Valid value: ELB|Instance|N/A
Provides a description of the instance state.
" - } - }, - "documentation":"The InstanceState data type.
" - }, - "InstanceStates":{ - "type":"list", - "member":{"shape":"InstanceState"} - }, - "Instances":{ - "type":"list", - "member":{"shape":"Instance"} - }, - "InvalidConfigurationRequestException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidConfigurationRequest", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Requested configuration change is invalid.
" - }, - "InvalidEndPointException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidInstance", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified EndPoint is not valid.
" - }, - "InvalidSchemeException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidScheme", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Invalid value for scheme. Scheme can only be specified for load balancers in VPC.
" - }, - "InvalidSecurityGroupException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more specified security groups do not exist.
" - }, - "InvalidSubnetException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The VPC has no Internet gateway.
" - }, - "LBCookieStickinessPolicies":{ - "type":"list", - "member":{"shape":"LBCookieStickinessPolicy"} - }, - "LBCookieStickinessPolicy":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"PolicyName", - "documentation":"The name for the policy being created. The name must be unique within the set of policies for this load balancer.
" - }, - "CookieExpirationPeriod":{ - "shape":"CookieExpirationPeriod", - "documentation":"The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session.
" - } - }, - "documentation":"The LBCookieStickinessPolicy data type.
" - }, - "Listener":{ - "type":"structure", - "required":[ - "Protocol", - "LoadBalancerPort", - "InstancePort" - ], - "members":{ - "Protocol":{ - "shape":"Protocol", - "documentation":"Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.
" - }, - "LoadBalancerPort":{ - "shape":"AccessPointPort", - "documentation":"Specifies the external load balancer port number. This property cannot be modified for the life of the load balancer.
" - }, - "InstanceProtocol":{ - "shape":"Protocol", - "documentation":"Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer.
InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP. Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the load balancer.
" - }, - "SSLCertificateId":{ - "shape":"SSLCertificateId", - "documentation":"The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.
" - } - }, - "documentation":"The Listener data type.
" - }, - "ListenerDescription":{ - "type":"structure", - "members":{ - "Listener":{"shape":"Listener"}, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"A list of policies enabled for this listener. An empty list indicates that no policies are enabled.
" - } - }, - "documentation":"The ListenerDescription data type.
" - }, - "ListenerDescriptions":{ - "type":"list", - "member":{"shape":"ListenerDescription"} - }, - "ListenerNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ListenerNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Load balancer does not have a listener configured at the given port.
" - }, - "Listeners":{ - "type":"list", - "member":{"shape":"Listener"} - }, - "LoadBalancerAttributeNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"LoadBalancerAttributeNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified load balancer attribute could not be found.
" - }, - "LoadBalancerAttributes":{ - "type":"structure", - "members":{ - "CrossZoneLoadBalancing":{ - "shape":"CrossZoneLoadBalancing", - "documentation":"The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.
For more information, see Enable Cross-Zone Load Balancing.
" - }, - "AccessLog":{ - "shape":"AccessLog", - "documentation":"The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.
For more information, see Enable Access Logs.
" - }, - "ConnectionDraining":{ - "shape":"ConnectionDraining", - "documentation":"The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.
For more information, see Enable Connection Draining.
" - }, - "ConnectionSettings":{ - "shape":"ConnectionSettings", - "documentation":"The name of the load balancer attribute.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
" - }, - "AdditionalAttributes":{"shape":"AdditionalAttributes"} - }, - "documentation":"The LoadBalancerAttributes data type.
Specifies the name associated with the load balancer.
" - }, - "DNSName":{ - "shape":"DNSName", - "documentation":"Specifies the external DNS name associated with the load balancer.
" - }, - "CanonicalHostedZoneName":{ - "shape":"DNSName", - "documentation":"Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For information on how to associate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
" - }, - "CanonicalHostedZoneNameID":{ - "shape":"DNSName", - "documentation":"Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
" - }, - "ListenerDescriptions":{ - "shape":"ListenerDescriptions", - "documentation":"LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.
" - }, - "Policies":{ - "shape":"Policies", - "documentation":"Provides a list of policies defined for the load balancer.
" - }, - "BackendServerDescriptions":{ - "shape":"BackendServerDescriptions", - "documentation":"Contains a list of back-end server descriptions.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"Specifies a list of Availability Zones.
" - }, - "Subnets":{ - "shape":"Subnets", - "documentation":"Provides a list of VPC subnet IDs for the load balancer.
" - }, - "VPCId":{ - "shape":"VPCId", - "documentation":"Provides the ID of the VPC attached to the load balancer.
" - }, - "Instances":{ - "shape":"Instances", - "documentation":"Provides a list of EC2 instance IDs for the load balancer.
" - }, - "HealthCheck":{ - "shape":"HealthCheck", - "documentation":"Specifies information regarding the various health probes conducted on the load balancer.
" - }, - "SourceSecurityGroup":{ - "shape":"SourceSecurityGroup", - "documentation":"The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"The security groups the load balancer is a member of (VPC only).
" - }, - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"Provides the date and time the load balancer was created.
" - }, - "Scheme":{ - "shape":"LoadBalancerScheme", - "documentation":"Specifies the type of load balancer.
If the Scheme is internet-facing, the load balancer has a publicly resolvable DNS name that resolves to public IP addresses.
If the Scheme is internal, the load balancer has a publicly resolvable DNS name that resolves to private IP addresses.
This option is only available for load balancers attached to an Amazon VPC.
" - } - }, - "documentation":"Contains the result of a successful invocation of DescribeLoadBalancers.
" - }, - "LoadBalancerDescriptions":{ - "type":"list", - "member":{"shape":"LoadBalancerDescription"} - }, - "LoadBalancerNames":{ - "type":"list", - "member":{"shape":"AccessPointName"} - }, - "LoadBalancerNamesMax20":{ - "type":"list", - "member":{"shape":"AccessPointName"}, - "min":1, - "max":20 - }, - "LoadBalancerScheme":{"type":"string"}, - "Marker":{"type":"string"}, - "ModifyLoadBalancerAttributesInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "LoadBalancerAttributes" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "LoadBalancerAttributes":{ - "shape":"LoadBalancerAttributes", - "documentation":"Attributes of the load balancer.
" - } - }, - "documentation":"The input for the ModifyLoadBalancerAttributes action.
" - }, - "ModifyLoadBalancerAttributesOutput":{ - "type":"structure", - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "LoadBalancerAttributes":{"shape":"LoadBalancerAttributes"} - }, - "documentation":"The output for the ModifyLoadBalancerAttributes action.
" - }, - "PageSize":{ - "type":"integer", - "min":1, - "max":400 - }, - "Policies":{ - "type":"structure", - "members":{ - "AppCookieStickinessPolicies":{ - "shape":"AppCookieStickinessPolicies", - "documentation":"A list of the AppCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.
" - }, - "LBCookieStickinessPolicies":{ - "shape":"LBCookieStickinessPolicies", - "documentation":"A list of LBCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.
" - }, - "OtherPolicies":{ - "shape":"PolicyNames", - "documentation":"A list of policy names other than the stickiness policies.
" - } - }, - "documentation":"The policies data type.
" - }, - "PolicyAttribute":{ - "type":"structure", - "members":{ - "AttributeName":{ - "shape":"AttributeName", - "documentation":"The name of the attribute associated with the policy.
" - }, - "AttributeValue":{ - "shape":"AttributeValue", - "documentation":"The value of the attribute associated with the policy.
" - } - }, - "documentation":"The PolicyAttribute data type. This data type contains a key/value pair that defines properties of a specific policy.
" - }, - "PolicyAttributeDescription":{ - "type":"structure", - "members":{ - "AttributeName":{ - "shape":"AttributeName", - "documentation":"The name of the attribute associated with the policy.
" - }, - "AttributeValue":{ - "shape":"AttributeValue", - "documentation":"The value of the attribute associated with the policy.
" - } - }, - "documentation":" The PolicyAttributeDescription data type. This data type is used to describe the attributes and values associated with a policy.
The name of the attribute associated with the policy type.
" - }, - "AttributeType":{ - "shape":"AttributeType", - "documentation":"The type of attribute. For example, Boolean, Integer, etc.
" - }, - "Description":{ - "shape":"Description", - "documentation":"A human-readable description of the attribute.
" - }, - "DefaultValue":{ - "shape":"DefaultValue", - "documentation":"The default value of the attribute, if applicable.
" - }, - "Cardinality":{ - "shape":"Cardinality", - "documentation":"The cardinality of the attribute. Valid Values:
The PolicyAttributeTypeDescription data type. This data type is used to describe values that are acceptable for the policy attribute.
The name of the policy associated with the load balancer.
" - }, - "PolicyTypeName":{ - "shape":"PolicyTypeName", - "documentation":"The name of the policy type associated with the load balancer.
" - }, - "PolicyAttributeDescriptions":{ - "shape":"PolicyAttributeDescriptions", - "documentation":"A list of policy attribute description structures.
" - } - }, - "documentation":" The PolicyDescription data type.
One or more specified policies were not found.
" - }, - "PolicyTypeDescription":{ - "type":"structure", - "members":{ - "PolicyTypeName":{ - "shape":"PolicyTypeName", - "documentation":"The name of the policy type.
" - }, - "Description":{ - "shape":"Description", - "documentation":"A human-readable description of the policy type.
" - }, - "PolicyAttributeTypeDescriptions":{ - "shape":"PolicyAttributeTypeDescriptions", - "documentation":"The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service.
" - } - }, - "documentation":"The PolicyTypeDescription data type.
" - }, - "PolicyTypeDescriptions":{ - "type":"list", - "member":{"shape":"PolicyTypeDescription"} - }, - "PolicyTypeName":{"type":"string"}, - "PolicyTypeNames":{ - "type":"list", - "member":{"shape":"PolicyTypeName"} - }, - "PolicyTypeNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"PolicyTypeNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more of the specified policy types do not exist.
" - }, - "Ports":{ - "type":"list", - "member":{"shape":"AccessPointPort"} - }, - "Protocol":{"type":"string"}, - "ReasonCode":{"type":"string"}, - "RegisterEndPointsInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "Instances" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer. The name must be unique within your set of load balancers.
" - }, - "Instances":{ - "shape":"Instances", - "documentation":"A list of instance IDs that should be registered with the load balancer.
" - } - }, - "documentation":"The input for the RegisterInstancesWithLoadBalancer action.
" - }, - "RegisterEndPointsOutput":{ - "type":"structure", - "members":{ - "Instances":{ - "shape":"Instances", - "documentation":"An updated list of instances for the load balancer.
" - } - }, - "documentation":"The output for the RegisterInstancesWithLoadBalancer action.
" - }, - "RemoveAvailabilityZonesInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "AvailabilityZones" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name associated with the load balancer.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"A list of Availability Zones to be removed from the load balancer.
The input for the DisableAvailabilityZonesForLoadBalancer action.
" - }, - "RemoveAvailabilityZonesOutput":{ - "type":"structure", - "members":{ - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"A list of updated Availability Zones for the load balancer.
" - } - }, - "documentation":"The output for the DisableAvailabilityZonesForLoadBalancer action.
" - }, - "RemoveTagsInput":{ - "type":"structure", - "required":[ - "LoadBalancerNames", - "Tags" - ], - "members":{ - "LoadBalancerNames":{ - "shape":"LoadBalancerNames", - "documentation":"The name of the load balancer. You can specify a maximum of one load balancer name.
" - }, - "Tags":{ - "shape":"TagKeyList", - "documentation":"A list of tag keys to remove.
" - } - }, - "documentation":"The input for the RemoveTags action.
" - }, - "RemoveTagsOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the RemoveTags action.
" - }, - "S3BucketName":{"type":"string"}, - "SSLCertificateId":{"type":"string"}, - "SecurityGroupId":{"type":"string"}, - "SecurityGroupName":{"type":"string"}, - "SecurityGroupOwnerAlias":{"type":"string"}, - "SecurityGroups":{ - "type":"list", - "member":{"shape":"SecurityGroupId"} - }, - "SetLoadBalancerListenerSSLCertificateInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "LoadBalancerPort", - "SSLCertificateId" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "LoadBalancerPort":{ - "shape":"AccessPointPort", - "documentation":"The port that uses the specified SSL certificate.
" - }, - "SSLCertificateId":{ - "shape":"SSLCertificateId", - "documentation":"The Amazon Resource Number (ARN) of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS Identity and Access Management User Guide.
" - } - }, - "documentation":"The input for the SetLoadBalancerListenerSSLCertificate action.
" - }, - "SetLoadBalancerListenerSSLCertificateOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the SetLoadBalancerListenerSSLCertificate action.
" - }, - "SetLoadBalancerPoliciesForBackendServerInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "InstancePort", - "PolicyNames" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The mnemonic name associated with the load balancer. This name must be unique within the set of your load balancers.
" - }, - "InstancePort":{ - "shape":"EndPointPort", - "documentation":"The port number associated with the back-end server.
" - }, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"List of policy names to be set. If the list is empty, then all current polices are removed from the back-end server.
" - } - }, - "documentation":"The input for the SetLoadBalancerPoliciesForBackendServer action.
" - }, - "SetLoadBalancerPoliciesForBackendServerOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the SetLoadBalancerPoliciesForBackendServer action.
" - }, - "SetLoadBalancerPoliciesOfListenerInput":{ - "type":"structure", - "required":[ - "LoadBalancerName", - "LoadBalancerPort", - "PolicyNames" - ], - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "LoadBalancerPort":{ - "shape":"AccessPointPort", - "documentation":"The external port of the load balancer to associate the policy.
" - }, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener.
" - } - }, - "documentation":"The input for the SetLoadBalancerPoliciesOfListener action.
" - }, - "SetLoadBalancerPoliciesOfListenerOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"The output for the SetLoadBalancerPoliciesOfListener action.
" - }, - "SourceSecurityGroup":{ - "type":"structure", - "members":{ - "OwnerAlias":{ - "shape":"SecurityGroupOwnerAlias", - "documentation":" Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the Amazon EC2 command line tool.
Name of the source security group. Use this value for the --source-group parameter of the ec2-authorize command in the Amazon EC2 command line tool.
This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
" - }, - "State":{"type":"string"}, - "StringVal":{"type":"string"}, - "SubnetId":{"type":"string"}, - "SubnetNotFoundException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubnetNotFound", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"One or more subnets were not found.
" - }, - "Subnets":{ - "type":"list", - "member":{"shape":"SubnetId"} - }, - "Tag":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"The key of the tag.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The value of the tag.
" - } - }, - "documentation":"Metadata assigned to a load balancer consisting of key-value pair.
For more information, see Tagging in the Elastic Load Balancing Developer Guide.
" - }, - "TagDescription":{ - "type":"structure", - "members":{ - "LoadBalancerName":{ - "shape":"AccessPointName", - "documentation":"The name of the load balancer.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"List of tags associated with the load balancer.
" - } - }, - "documentation":"The descriptions of all the tags associated with load balancer.
" - }, - "TagDescriptions":{ - "type":"list", - "member":{"shape":"TagDescription"} - }, - "TagKey":{ - "type":"string", - "min":1, - "max":128, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKeyOnly"}, - "min":1 - }, - "TagKeyOnly":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"The name of the key.
" - } - }, - "documentation":"The key of a tag to be removed.
" - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "min":1 - }, - "TagValue":{ - "type":"string", - "min":0, - "max":256, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TooManyAccessPointsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyLoadBalancers", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for the number of load balancers has already been reached.
" - }, - "TooManyPoliciesException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyPolicies", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Quota for number of policies for this load balancer has already been reached.
" - }, - "TooManyTagsException":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TooManyTags", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for the number of tags that can be assigned to a load balancer has been reached.
" - }, - "UnhealthyThreshold":{ - "type":"integer", - "min":2, - "max":10 - }, - "VPCId":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/elb/2012-06-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/elb/2012-06-01.paginators.json deleted file mode 100644 index 444a77a541..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/elb/2012-06-01.paginators.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "pagination": { - "DescribeLoadBalancers": { - "input_token": "Marker", - "output_token": "NextMarker", - "result_key": "LoadBalancerDescriptions", - "limit_key": "PageSize" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.normal.json deleted file mode 100644 index 13b4a5e46b..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.normal.json +++ /dev/null @@ -1,2342 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2009-03-31", - "endpointPrefix":"elasticmapreduce", - "jsonVersion":"1.1", - "serviceAbbreviation":"Amazon EMR", - "serviceFullName":"Amazon Elastic MapReduce", - "signatureVersion":"v4", - "targetPrefix":"ElasticMapReduce", - "timestampFormat":"unixTimestamp", - "protocol":"json" - }, - "documentation":"Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.
", - "operations":{ - "AddInstanceGroups":{ - "name":"AddInstanceGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddInstanceGroupsInput", - "documentation":"Input to an AddInstanceGroups call.
" - }, - "output":{ - "shape":"AddInstanceGroupsOutput", - "documentation":"Output from an AddInstanceGroups call.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":"AddInstanceGroups adds an instance group to a running cluster.
" - }, - "AddJobFlowSteps":{ - "name":"AddJobFlowSteps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddJobFlowStepsInput", - "documentation":"The input argument to the AddJobFlowSteps operation.
" - }, - "output":{ - "shape":"AddJobFlowStepsOutput", - "documentation":"The output for the AddJobFlowSteps operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":"AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow.
If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.
A step specifies the location of a JAR file stored either on the master node of the job flow or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.
Elastic MapReduce executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.
You can only add steps to a job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
" - }, - "AddTags":{ - "name":"AddTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddTagsInput", - "documentation":"This input identifies a cluster and a list of tags to attach.
" - }, - "output":{ - "shape":"AddTagsOutput", - "documentation":"This output indicates the result of adding tags to a resource.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources.
" - }, - "DescribeCluster":{ - "name":"DescribeCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeClusterInput", - "documentation":"This input determines which cluster to describe.
" - }, - "output":{ - "shape":"DescribeClusterOutput", - "documentation":"This output contains the description of the cluster.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.
" - }, - "DescribeJobFlows":{ - "name":"DescribeJobFlows", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeJobFlowsInput", - "documentation":"The input for the DescribeJobFlows operation.
" - }, - "output":{ - "shape":"DescribeJobFlowsOutput", - "documentation":"The output for the DescribeJobFlows operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "deprecated":true, - "documentation":"This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
Regardless of supplied parameters, only job flows created within the last two months are returned.
If no parameters are supplied, then job flows matching either of the following criteria are returned:
RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.
" - }, - "DescribeStep":{ - "name":"DescribeStep", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeStepInput", - "documentation":"This input determines which step to describe.
" - }, - "output":{ - "shape":"DescribeStepOutput", - "documentation":"This output contains the description of the cluster step.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides more detail about the cluster step.
" - }, - "ListBootstrapActions":{ - "name":"ListBootstrapActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListBootstrapActionsInput", - "documentation":"This input determines which bootstrap actions to retrieve.
" - }, - "output":{ - "shape":"ListBootstrapActionsOutput", - "documentation":"This output contains the boostrap actions detail .
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides information about the bootstrap actions associated with a cluster.
" - }, - "ListClusters":{ - "name":"ListClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListClustersInput", - "documentation":"This input determines how the ListClusters action filters the list of clusters that it returns.
" - }, - "output":{ - "shape":"ListClustersOutput", - "documentation":"This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
" - }, - "ListInstanceGroups":{ - "name":"ListInstanceGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListInstanceGroupsInput", - "documentation":"This input determines which instance groups to retrieve.
" - }, - "output":{ - "shape":"ListInstanceGroupsOutput", - "documentation":"This input determines which instance groups to retrieve.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides all available details about the instance groups in a cluster.
" - }, - "ListInstances":{ - "name":"ListInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListInstancesInput", - "documentation":"This input determines which instances to list.
" - }, - "output":{ - "shape":"ListInstancesOutput", - "documentation":"This output contains the list of instances.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.
" - }, - "ListSteps":{ - "name":"ListSteps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListStepsInput", - "documentation":"This input determines which steps to list.
" - }, - "output":{ - "shape":"ListStepsOutput", - "documentation":"This output contains the list of steps.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Provides a list of steps for the cluster.
" - }, - "ModifyInstanceGroups":{ - "name":"ModifyInstanceGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyInstanceGroupsInput", - "documentation":"Change the size of some instance groups.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":"ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.
" - }, - "RemoveTags":{ - "name":"RemoveTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveTagsInput", - "documentation":"This input identifies a cluster and a list of tags to remove.
" - }, - "output":{ - "shape":"RemoveTagsOutput", - "documentation":"This output indicates the result of removing tags from a resource.
" - }, - "errors":[ - { - "shape":"InternalServerException", - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - } - ], - "documentation":"Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources.
The following example removes the stack tag with value Prod from a cluster:
" - }, - "RunJobFlow":{ - "name":"RunJobFlow", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RunJobFlowInput", - "documentation":"Input to the RunJobFlow operation.
" - }, - "output":{ - "shape":"RunJobFlowOutput", - "documentation":"The result of the RunJobFlow operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":" RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the job flow will transition to the WAITING state rather than shutting down once the steps have completed.
For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the job flow and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.
A maximum of 256 steps are allowed in each job flow.
If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.
For long running job flows, we recommend that you periodically store your results.
" - }, - "SetTerminationProtection":{ - "name":"SetTerminationProtection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetTerminationProtectionInput", - "documentation":"The input argument to the TerminationProtection operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":"SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.
SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage.
To terminate a job flow that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false.
For more information, go to Protecting a Job Flow from Termination in the Amazon Elastic MapReduce Developer's Guide.
" - }, - "SetVisibleToAllUsers":{ - "name":"SetVisibleToAllUsers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetVisibleToAllUsersInput", - "documentation":"The input to the SetVisibleToAllUsers action.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":"Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of a job flow when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow.
Input to the TerminateJobFlows operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - } - ], - "documentation":"TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the job flow is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the job flow was created.
The maximum number of JobFlows allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 5-20 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances.
" - } - }, - "shapes":{ - "ActionOnFailure":{ - "type":"string", - "enum":[ - "TERMINATE_JOB_FLOW", - "TERMINATE_CLUSTER", - "CANCEL_AND_WAIT", - "CONTINUE" - ] - }, - "AddInstanceGroupsInput":{ - "type":"structure", - "required":[ - "InstanceGroups", - "JobFlowId" - ], - "members":{ - "InstanceGroups":{ - "shape":"InstanceGroupConfigList", - "documentation":"Instance Groups to add.
" - }, - "JobFlowId":{ - "shape":"XmlStringMaxLen256", - "documentation":"Job flow in which to add the instance groups.
" - } - }, - "documentation":"Input to an AddInstanceGroups call.
" - }, - "AddInstanceGroupsOutput":{ - "type":"structure", - "members":{ - "JobFlowId":{ - "shape":"XmlStringMaxLen256", - "documentation":"The job flow ID in which the instance groups are added.
" - }, - "InstanceGroupIds":{ - "shape":"InstanceGroupIdsList", - "documentation":"Instance group IDs of the newly created instance groups.
" - } - }, - "documentation":"Output from an AddInstanceGroups call.
" - }, - "AddJobFlowStepsInput":{ - "type":"structure", - "required":[ - "JobFlowId", - "Steps" - ], - "members":{ - "JobFlowId":{ - "shape":"XmlStringMaxLen256", - "documentation":"A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.
" - }, - "Steps":{ - "shape":"StepConfigList", - "documentation":"A list of StepConfig to be executed by the job flow.
" - } - }, - "documentation":"The input argument to the AddJobFlowSteps operation.
" - }, - "AddJobFlowStepsOutput":{ - "type":"structure", - "members":{ - "StepIds":{ - "shape":"StepIdsList", - "documentation":"The identifiers of the list of steps added to the job flow.
" - } - }, - "documentation":"The output for the AddJobFlowSteps operation.
" - }, - "AddTagsInput":{ - "type":"structure", - "required":[ - "ResourceId", - "Tags" - ], - "members":{ - "ResourceId":{ - "shape":"ResourceId", - "documentation":"The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
" - } - }, - "documentation":"This input identifies a cluster and a list of tags to attach.
" - }, - "AddTagsOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"This output indicates the result of adding tags to a resource.
" - }, - "Application":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the application.
" - }, - "Version":{ - "shape":"String", - "documentation":"The version of the application.
" - }, - "Args":{ - "shape":"StringList", - "documentation":"Arguments for Amazon EMR to pass to the application.
" - }, - "AdditionalInfo":{ - "shape":"StringMap", - "documentation":"This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.
" - } - }, - "documentation":"An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:
The name of the bootstrap action.
" - }, - "ScriptBootstrapAction":{ - "shape":"ScriptBootstrapActionConfig", - "documentation":"The script run by the bootstrap action.
" - } - }, - "documentation":"Configuration of a bootstrap action.
" - }, - "BootstrapActionConfigList":{ - "type":"list", - "member":{"shape":"BootstrapActionConfig"} - }, - "BootstrapActionDetail":{ - "type":"structure", - "members":{ - "BootstrapActionConfig":{ - "shape":"BootstrapActionConfig", - "documentation":"A description of the bootstrap action.
" - } - }, - "documentation":"Reports the configuration of a bootstrap action in a job flow.
" - }, - "BootstrapActionDetailList":{ - "type":"list", - "member":{"shape":"BootstrapActionDetail"} - }, - "Cluster":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"ClusterId", - "documentation":"The unique identifier for the cluster.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the cluster.
" - }, - "Status":{ - "shape":"ClusterStatus", - "documentation":"The current status details about the cluster.
" - }, - "Ec2InstanceAttributes":{"shape":"Ec2InstanceAttributes"}, - "LogUri":{ - "shape":"String", - "documentation":"The path to the Amazon S3 location where logs for this cluster are stored.
" - }, - "RequestedAmiVersion":{ - "shape":"String", - "documentation":"The AMI version requested for this cluster.
" - }, - "RunningAmiVersion":{ - "shape":"String", - "documentation":"The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as \"latest\".
" - }, - "AutoTerminate":{ - "shape":"Boolean", - "documentation":"Specifies whether the cluster should terminate after completing all steps.
" - }, - "TerminationProtected":{ - "shape":"Boolean", - "documentation":"Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
" - }, - "VisibleToAllUsers":{ - "shape":"Boolean", - "documentation":"Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
The applications installed on this cluster.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tags associated with a cluster.
" - }, - "ServiceRole":{ - "shape":"String", - "documentation":"The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
" - }, - "NormalizedInstanceHours":{ - "shape":"Integer", - "documentation":"An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
" - }, - "MasterPublicDnsName":{ - "shape":"String", - "documentation":"The public DNS name of the master Ec2 instance.
" - } - }, - "documentation":"The detailed description of the cluster.
" - }, - "ClusterId":{"type":"string"}, - "ClusterState":{ - "type":"string", - "enum":[ - "STARTING", - "BOOTSTRAPPING", - "RUNNING", - "WAITING", - "TERMINATING", - "TERMINATED", - "TERMINATED_WITH_ERRORS" - ] - }, - "ClusterStateChangeReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"ClusterStateChangeReasonCode", - "documentation":"The programmatic code for the state change reason.
" - }, - "Message":{ - "shape":"String", - "documentation":"The descriptive message for the state change reason.
" - } - }, - "documentation":"The reason that the cluster changed to its current state.
" - }, - "ClusterStateChangeReasonCode":{ - "type":"string", - "enum":[ - "INTERNAL_ERROR", - "VALIDATION_ERROR", - "INSTANCE_FAILURE", - "BOOTSTRAP_FAILURE", - "USER_REQUEST", - "STEP_FAILURE", - "ALL_STEPS_COMPLETED" - ] - }, - "ClusterStateList":{ - "type":"list", - "member":{"shape":"ClusterState"} - }, - "ClusterStatus":{ - "type":"structure", - "members":{ - "State":{ - "shape":"ClusterState", - "documentation":"The current state of the cluster.
" - }, - "StateChangeReason":{ - "shape":"ClusterStateChangeReason", - "documentation":"The reason for the cluster status change.
" - }, - "Timeline":{ - "shape":"ClusterTimeline", - "documentation":"A timeline that represents the status of a cluster over the lifetime of the cluster.
" - } - }, - "documentation":"The detailed status of the cluster.
" - }, - "ClusterSummary":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"ClusterId", - "documentation":"The unique identifier for the cluster.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the cluster.
" - }, - "Status":{ - "shape":"ClusterStatus", - "documentation":"The details about the current status of the cluster.
" - }, - "NormalizedInstanceHours":{ - "shape":"Integer", - "documentation":"An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
" - } - }, - "documentation":"The summary description of the cluster.
" - }, - "ClusterSummaryList":{ - "type":"list", - "member":{"shape":"ClusterSummary"} - }, - "ClusterTimeline":{ - "type":"structure", - "members":{ - "CreationDateTime":{ - "shape":"Date", - "documentation":"The creation date and time of the cluster.
" - }, - "ReadyDateTime":{ - "shape":"Date", - "documentation":"The date and time when the cluster was ready to execute steps.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The date and time when the cluster was terminated.
" - } - }, - "documentation":"Represents the timeline of the cluster's lifecycle.
" - }, - "Command":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the command.
" - }, - "ScriptPath":{ - "shape":"String", - "documentation":"The Amazon S3 location of the command script.
" - }, - "Args":{ - "shape":"StringList", - "documentation":"Arguments for Amazon EMR to pass to the command for execution.
" - } - }, - "documentation":"An entity describing an executable that runs on a cluster.
" - }, - "CommandList":{ - "type":"list", - "member":{"shape":"Command"} - }, - "Date":{"type":"timestamp"}, - "DescribeClusterInput":{ - "type":"structure", - "required":["ClusterId"], - "members":{ - "ClusterId":{ - "shape":"ClusterId", - "documentation":"The identifier of the cluster to describe.
" - } - }, - "documentation":"This input determines which cluster to describe.
" - }, - "DescribeClusterOutput":{ - "type":"structure", - "members":{ - "Cluster":{ - "shape":"Cluster", - "documentation":"This output contains the details for the requested cluster.
" - } - }, - "documentation":"This output contains the description of the cluster.
" - }, - "DescribeJobFlowsInput":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Date", - "documentation":"Return only job flows created after this date and time.
" - }, - "CreatedBefore":{ - "shape":"Date", - "documentation":"Return only job flows created before this date and time.
" - }, - "JobFlowIds":{ - "shape":"XmlStringList", - "documentation":"Return only job flows whose job flow ID is contained in this list.
" - }, - "JobFlowStates":{ - "shape":"JobFlowExecutionStateList", - "documentation":"Return only job flows whose state is contained in this list.
" - } - }, - "documentation":"The input for the DescribeJobFlows operation.
" - }, - "DescribeJobFlowsOutput":{ - "type":"structure", - "members":{ - "JobFlows":{ - "shape":"JobFlowDetailList", - "documentation":"A list of job flows matching the parameters supplied.
" - } - }, - "documentation":"The output for the DescribeJobFlows operation.
" - }, - "DescribeStepInput":{ - "type":"structure", - "required":[ - "ClusterId", - "StepId" - ], - "members":{ - "ClusterId":{ - "shape":"ClusterId", - "documentation":"The identifier of the cluster with steps to describe.
" - }, - "StepId":{ - "shape":"StepId", - "documentation":"The identifier of the step to describe.
" - } - }, - "documentation":"This input determines which step to describe.
" - }, - "DescribeStepOutput":{ - "type":"structure", - "members":{ - "Step":{ - "shape":"Step", - "documentation":"The step details for the requested step identifier.
" - } - }, - "documentation":"This output contains the description of the cluster step.
" - }, - "EC2InstanceIdsToTerminateList":{ - "type":"list", - "member":{"shape":"InstanceId"} - }, - "Ec2InstanceAttributes":{ - "type":"structure", - "members":{ - "Ec2KeyName":{ - "shape":"String", - "documentation":"The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named \"hadoop\".
" - }, - "Ec2SubnetId":{ - "shape":"String", - "documentation":"To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal AWS cloud, outside of a VPC.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.
" - }, - "Ec2AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the cluster will run.
" - }, - "IamInstanceProfile":{ - "shape":"String", - "documentation":"The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
" - }, - "EmrManagedMasterSecurityGroup":{ - "shape":"String", - "documentation":"The identifier of the Amazon EC2 security group (managed by Amazon Elastic MapReduce) for the master node.
" - }, - "EmrManagedSlaveSecurityGroup":{ - "shape":"String", - "documentation":"The identifier of the Amazon EC2 security group (managed by Amazon Elastic MapReduce) for the slave nodes.
" - }, - "AdditionalMasterSecurityGroups":{ - "shape":"StringList", - "documentation":"A list of additional Amazon EC2 security group IDs for the master node.
" - }, - "AdditionalSlaveSecurityGroups":{ - "shape":"StringList", - "documentation":"A list of additional Amazon EC2 security group IDs for the slave nodes.
" - } - }, - "documentation":"Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.
" - }, - "ErrorCode":{ - "type":"string", - "min":1, - "max":256 - }, - "ErrorMessage":{"type":"string"}, - "HadoopJarStepConfig":{ - "type":"structure", - "required":["Jar"], - "members":{ - "Properties":{ - "shape":"KeyValueList", - "documentation":"A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
" - }, - "Jar":{ - "shape":"XmlString", - "documentation":"A path to a JAR file run during the step.
" - }, - "MainClass":{ - "shape":"XmlString", - "documentation":"The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
" - }, - "Args":{ - "shape":"XmlStringList", - "documentation":"A list of command line arguments passed to the JAR file's main function when executed.
" - } - }, - "documentation":"A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
" - }, - "HadoopStepConfig":{ - "type":"structure", - "members":{ - "Jar":{ - "shape":"String", - "documentation":"The path to the JAR file that runs during the step.
" - }, - "Properties":{ - "shape":"StringMap", - "documentation":"The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
" - }, - "MainClass":{ - "shape":"String", - "documentation":"The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
" - }, - "Args":{ - "shape":"StringList", - "documentation":"The list of command line arguments to pass to the JAR file's main function for execution.
" - } - }, - "documentation":"A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
" - }, - "Instance":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"InstanceId", - "documentation":"The unique identifier for the instance in Amazon EMR.
" - }, - "Ec2InstanceId":{ - "shape":"InstanceId", - "documentation":"The unique identifier of the instance in Amazon EC2.
" - }, - "PublicDnsName":{ - "shape":"String", - "documentation":"The public DNS name of the instance.
" - }, - "PublicIpAddress":{ - "shape":"String", - "documentation":"The public IP address of the instance.
" - }, - "PrivateDnsName":{ - "shape":"String", - "documentation":"The private DNS name of the instance.
" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IP address of the instance.
" - }, - "Status":{ - "shape":"InstanceStatus", - "documentation":"The current status of the instance.
" - } - }, - "documentation":"Represents an EC2 instance provisioned as part of cluster.
" - }, - "InstanceGroup":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"InstanceGroupId", - "documentation":"The identifier of the instance group.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the instance group.
" - }, - "Market":{ - "shape":"MarketType", - "documentation":"The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
" - }, - "InstanceGroupType":{ - "shape":"InstanceGroupType", - "documentation":"The type of the instance group. Valid values are MASTER, CORE or TASK.
" - }, - "BidPrice":{ - "shape":"String", - "documentation":"The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The EC2 instance type for all instances in the instance group.
" - }, - "RequestedInstanceCount":{ - "shape":"Integer", - "documentation":"The target number of instances for the instance group.
" - }, - "RunningInstanceCount":{ - "shape":"Integer", - "documentation":"The number of instances currently running in this instance group.
" - }, - "Status":{ - "shape":"InstanceGroupStatus", - "documentation":"The current status of the instance group.
" - } - }, - "documentation":"This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.
" - }, - "InstanceGroupConfig":{ - "type":"structure", - "required":[ - "InstanceRole", - "InstanceType", - "InstanceCount" - ], - "members":{ - "Name":{ - "shape":"XmlStringMaxLen256", - "documentation":"Friendly name given to the instance group.
" - }, - "Market":{ - "shape":"MarketType", - "documentation":"Market type of the Amazon EC2 instances used to create a cluster node.
" - }, - "InstanceRole":{ - "shape":"InstanceRoleType", - "documentation":"The role of the instance group in the cluster.
" - }, - "BidPrice":{ - "shape":"XmlStringMaxLen256", - "documentation":"Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.
" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The Amazon EC2 instance type for all instances in the instance group.
" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"Target number of instances for the instance group.
" - } - }, - "documentation":"Configuration defining a new instance group.
" - }, - "InstanceGroupConfigList":{ - "type":"list", - "member":{"shape":"InstanceGroupConfig"} - }, - "InstanceGroupDetail":{ - "type":"structure", - "required":[ - "Market", - "InstanceRole", - "InstanceType", - "InstanceRequestCount", - "InstanceRunningCount", - "State", - "CreationDateTime" - ], - "members":{ - "InstanceGroupId":{ - "shape":"XmlStringMaxLen256", - "documentation":"Unique identifier for the instance group.
" - }, - "Name":{ - "shape":"XmlStringMaxLen256", - "documentation":"Friendly name for the instance group.
" - }, - "Market":{ - "shape":"MarketType", - "documentation":"Market type of the Amazon EC2 instances used to create a cluster node.
" - }, - "InstanceRole":{ - "shape":"InstanceRoleType", - "documentation":"Instance group role in the cluster
" - }, - "BidPrice":{ - "shape":"XmlStringMaxLen256", - "documentation":"Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.
" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"Amazon EC2 Instance type.
" - }, - "InstanceRequestCount":{ - "shape":"Integer", - "documentation":"Target number of instances to run in the instance group.
" - }, - "InstanceRunningCount":{ - "shape":"Integer", - "documentation":"Actual count of running instances.
" - }, - "State":{ - "shape":"InstanceGroupState", - "documentation":"State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.
" - }, - "LastStateChangeReason":{ - "shape":"XmlString", - "documentation":"Details regarding the state of the instance group.
" - }, - "CreationDateTime":{ - "shape":"Date", - "documentation":"The date/time the instance group was created.
" - }, - "StartDateTime":{ - "shape":"Date", - "documentation":"The date/time the instance group was started.
" - }, - "ReadyDateTime":{ - "shape":"Date", - "documentation":"The date/time the instance group was available to the cluster.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The date/time the instance group was terminated.
" - } - }, - "documentation":"Detailed information about an instance group.
" - }, - "InstanceGroupDetailList":{ - "type":"list", - "member":{"shape":"InstanceGroupDetail"} - }, - "InstanceGroupId":{"type":"string"}, - "InstanceGroupIdsList":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen256"} - }, - "InstanceGroupList":{ - "type":"list", - "member":{"shape":"InstanceGroup"} - }, - "InstanceGroupModifyConfig":{ - "type":"structure", - "required":["InstanceGroupId"], - "members":{ - "InstanceGroupId":{ - "shape":"XmlStringMaxLen256", - "documentation":"Unique ID of the instance group to expand or shrink.
" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"Target size for the instance group.
" - }, - "EC2InstanceIdsToTerminate":{ - "shape":"EC2InstanceIdsToTerminateList", - "documentation":"The EC2 InstanceIds to terminate. For advanced users only. Once you terminate the instances, the instance group will not return to its original requested size.
" - } - }, - "documentation":"Modify an instance group size.
" - }, - "InstanceGroupModifyConfigList":{ - "type":"list", - "member":{"shape":"InstanceGroupModifyConfig"} - }, - "InstanceGroupState":{ - "type":"string", - "enum":[ - "PROVISIONING", - "BOOTSTRAPPING", - "RUNNING", - "RESIZING", - "SUSPENDED", - "TERMINATING", - "TERMINATED", - "ARRESTED", - "SHUTTING_DOWN", - "ENDED" - ] - }, - "InstanceGroupStateChangeReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"InstanceGroupStateChangeReasonCode", - "documentation":"The programmable code for the state change reason.
" - }, - "Message":{ - "shape":"String", - "documentation":"The status change reason description.
" - } - }, - "documentation":"The status change reason details for the instance group.
" - }, - "InstanceGroupStateChangeReasonCode":{ - "type":"string", - "enum":[ - "INTERNAL_ERROR", - "VALIDATION_ERROR", - "INSTANCE_FAILURE", - "CLUSTER_TERMINATED" - ] - }, - "InstanceGroupStatus":{ - "type":"structure", - "members":{ - "State":{ - "shape":"InstanceGroupState", - "documentation":"The current state of the instance group.
" - }, - "StateChangeReason":{ - "shape":"InstanceGroupStateChangeReason", - "documentation":"The status change reason details for the instance group.
" - }, - "Timeline":{ - "shape":"InstanceGroupTimeline", - "documentation":"The timeline of the instance group status over time.
" - } - }, - "documentation":"The details of the instance group status.
" - }, - "InstanceGroupTimeline":{ - "type":"structure", - "members":{ - "CreationDateTime":{ - "shape":"Date", - "documentation":"The creation date and time of the instance group.
" - }, - "ReadyDateTime":{ - "shape":"Date", - "documentation":"The date and time when the instance group became ready to perform tasks.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The date and time when the instance group terminated.
" - } - }, - "documentation":"The timeline of the instance group lifecycle.
" - }, - "InstanceGroupType":{ - "type":"string", - "enum":[ - "MASTER", - "CORE", - "TASK" - ] - }, - "InstanceGroupTypeList":{ - "type":"list", - "member":{"shape":"InstanceGroupType"} - }, - "InstanceId":{"type":"string"}, - "InstanceList":{ - "type":"list", - "member":{"shape":"Instance"} - }, - "InstanceRoleType":{ - "type":"string", - "enum":[ - "MASTER", - "CORE", - "TASK" - ] - }, - "InstanceState":{ - "type":"string", - "enum":[ - "AWAITING_FULFILLMENT", - "PROVISIONING", - "BOOTSTRAPPING", - "RUNNING", - "TERMINATED" - ] - }, - "InstanceStateChangeReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"InstanceStateChangeReasonCode", - "documentation":"The programmable code for the state change reason.
" - }, - "Message":{ - "shape":"String", - "documentation":"The status change reason description.
" - } - }, - "documentation":"The details of the status change reason for the instance.
" - }, - "InstanceStateChangeReasonCode":{ - "type":"string", - "enum":[ - "INTERNAL_ERROR", - "VALIDATION_ERROR", - "INSTANCE_FAILURE", - "BOOTSTRAP_FAILURE", - "CLUSTER_TERMINATED" - ] - }, - "InstanceStatus":{ - "type":"structure", - "members":{ - "State":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
" - }, - "StateChangeReason":{ - "shape":"InstanceStateChangeReason", - "documentation":"The details of the status change reason for the instance.
" - }, - "Timeline":{ - "shape":"InstanceTimeline", - "documentation":"The timeline of the instance status over time.
" - } - }, - "documentation":"The instance status details.
" - }, - "InstanceTimeline":{ - "type":"structure", - "members":{ - "CreationDateTime":{ - "shape":"Date", - "documentation":"The creation date and time of the instance.
" - }, - "ReadyDateTime":{ - "shape":"Date", - "documentation":"The date and time when the instance was ready to perform tasks.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The date and time when the instance was terminated.
" - } - }, - "documentation":"The timeline of the instance lifecycle.
" - }, - "InstanceType":{ - "type":"string", - "min":1, - "max":256, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "Integer":{"type":"integer"}, - "InternalServerError":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InternalFailure", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"Indicates that an error occurred while processing the request and that the request was not completed.
" - }, - "InternalServerException":{ - "type":"structure", - "members":{ - "Message":{ - "shape":"ErrorMessage", - "documentation":"The message associated with the exception.
" - } - }, - "exception":true, - "fault":true, - "documentation":"This exception occurs when there is an internal failure in the EMR service.
" - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "ErrorCode":{ - "shape":"ErrorCode", - "documentation":"The error code associated with the exception.
" - }, - "Message":{ - "shape":"ErrorMessage", - "documentation":"The message associated with the exception.
" - } - }, - "exception":true, - "documentation":"This exception occurs when there is something wrong with user input.
" - }, - "JobFlowDetail":{ - "type":"structure", - "required":[ - "JobFlowId", - "Name", - "ExecutionStatusDetail", - "Instances" - ], - "members":{ - "JobFlowId":{ - "shape":"XmlStringMaxLen256", - "documentation":"The job flow identifier.
" - }, - "Name":{ - "shape":"XmlStringMaxLen256", - "documentation":"The name of the job flow.
" - }, - "LogUri":{ - "shape":"XmlString", - "documentation":"The location in Amazon S3 where log files for the job are stored.
" - }, - "AmiVersion":{ - "shape":"XmlStringMaxLen256", - "documentation":"The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
" - }, - "ExecutionStatusDetail":{ - "shape":"JobFlowExecutionStatusDetail", - "documentation":"Describes the execution status of the job flow.
" - }, - "Instances":{ - "shape":"JobFlowInstancesDetail", - "documentation":"Describes the Amazon EC2 instances of the job flow.
" - }, - "Steps":{ - "shape":"StepDetailList", - "documentation":"A list of steps run by the job flow.
" - }, - "BootstrapActions":{ - "shape":"BootstrapActionDetailList", - "documentation":"A list of the bootstrap actions run by the job flow.
" - }, - "SupportedProducts":{ - "shape":"SupportedProductsList", - "documentation":"A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.
" - }, - "VisibleToAllUsers":{ - "shape":"Boolean", - "documentation":"Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
" - }, - "ServiceRole":{ - "shape":"XmlString", - "documentation":"The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
" - } - }, - "documentation":"A description of a job flow.
" - }, - "JobFlowDetailList":{ - "type":"list", - "member":{"shape":"JobFlowDetail"} - }, - "JobFlowExecutionState":{ - "type":"string", - "enum":[ - "STARTING", - "BOOTSTRAPPING", - "RUNNING", - "WAITING", - "SHUTTING_DOWN", - "TERMINATED", - "COMPLETED", - "FAILED" - ], - "documentation":"The type of instance.
A small instance
A large instance
The state of the job flow.
" - }, - "CreationDateTime":{ - "shape":"Date", - "documentation":"The creation date and time of the job flow.
" - }, - "StartDateTime":{ - "shape":"Date", - "documentation":"The start date and time of the job flow.
" - }, - "ReadyDateTime":{ - "shape":"Date", - "documentation":"The date and time when the job flow was ready to start running bootstrap actions.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The completion date and time of the job flow.
" - }, - "LastStateChangeReason":{ - "shape":"XmlString", - "documentation":"Description of the job flow last changed state.
" - } - }, - "documentation":"Describes the status of the job flow.
" - }, - "JobFlowInstancesConfig":{ - "type":"structure", - "members":{ - "MasterInstanceType":{ - "shape":"InstanceType", - "documentation":"The EC2 instance type of the master node.
" - }, - "SlaveInstanceType":{ - "shape":"InstanceType", - "documentation":"The EC2 instance type of the slave nodes.
" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of Amazon EC2 instances used to execute the job flow.
" - }, - "InstanceGroups":{ - "shape":"InstanceGroupConfigList", - "documentation":"Configuration for the job flow's instance groups.
" - }, - "Ec2KeyName":{ - "shape":"XmlStringMaxLen256", - "documentation":"The name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called \"hadoop.\"
" - }, - "Placement":{ - "shape":"PlacementType", - "documentation":"The Availability Zone the job flow will run in.
" - }, - "KeepJobFlowAliveWhenNoSteps":{ - "shape":"Boolean", - "documentation":"Specifies whether the job flow should terminate after completing all steps.
" - }, - "TerminationProtected":{ - "shape":"Boolean", - "documentation":"Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.
" - }, - "HadoopVersion":{ - "shape":"XmlStringMaxLen256", - "documentation":"The Hadoop version for the job flow. Valid inputs are \"0.18\", \"0.20\", \"0.20.205\", \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
" - }, - "Ec2SubnetId":{ - "shape":"XmlStringMaxLen256", - "documentation":"To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC.
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.
" - }, - "EmrManagedMasterSecurityGroup":{ - "shape":"XmlStringMaxLen256", - "documentation":"The identifier of the Amazon EC2 security group (managed by Amazon ElasticMapReduce) for the master node.
" - }, - "EmrManagedSlaveSecurityGroup":{ - "shape":"XmlStringMaxLen256", - "documentation":"The identifier of the Amazon EC2 security group (managed by Amazon ElasticMapReduce) for the slave nodes.
" - }, - "AdditionalMasterSecurityGroups":{ - "shape":"SecurityGroupsList", - "documentation":"A list of additional Amazon EC2 security group IDs for the master node.
" - }, - "AdditionalSlaveSecurityGroups":{ - "shape":"SecurityGroupsList", - "documentation":"A list of additional Amazon EC2 security group IDs for the slave nodes.
" - } - }, - "documentation":"A description of the Amazon EC2 instance running the job flow. A valid JobFlowInstancesConfig must contain at least InstanceGroups, which is the recommended configuration. However, a valid alternative is to have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present).
" - }, - "JobFlowInstancesDetail":{ - "type":"structure", - "required":[ - "MasterInstanceType", - "SlaveInstanceType", - "InstanceCount" - ], - "members":{ - "MasterInstanceType":{ - "shape":"InstanceType", - "documentation":"The Amazon EC2 master node instance type.
" - }, - "MasterPublicDnsName":{ - "shape":"XmlString", - "documentation":"The DNS name of the master node.
" - }, - "MasterInstanceId":{ - "shape":"XmlString", - "documentation":"The Amazon EC2 instance identifier of the master node.
" - }, - "SlaveInstanceType":{ - "shape":"InstanceType", - "documentation":"The Amazon EC2 slave node instance type.
" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.
" - }, - "InstanceGroups":{ - "shape":"InstanceGroupDetailList", - "documentation":"Details about the job flow's instance groups.
" - }, - "NormalizedInstanceHours":{ - "shape":"Integer", - "documentation":"An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.
" - }, - "Ec2KeyName":{ - "shape":"XmlStringMaxLen256", - "documentation":"The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.
" - }, - "Ec2SubnetId":{ - "shape":"XmlStringMaxLen256", - "documentation":"For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.
" - }, - "Placement":{ - "shape":"PlacementType", - "documentation":"The Amazon EC2 Availability Zone for the job flow.
" - }, - "KeepJobFlowAliveWhenNoSteps":{ - "shape":"Boolean", - "documentation":"Specifies whether the job flow should terminate after completing all steps.
" - }, - "TerminationProtected":{ - "shape":"Boolean", - "documentation":"Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.
" - }, - "HadoopVersion":{ - "shape":"XmlStringMaxLen256", - "documentation":"The Hadoop version for the job flow.
" - } - }, - "documentation":"Specify the type of Amazon EC2 instances to run the job flow on.
" - }, - "KeyValue":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"XmlString", - "documentation":"The unique identifier of a key value pair.
" - }, - "Value":{ - "shape":"XmlString", - "documentation":"The value part of the identified key.
" - } - }, - "documentation":"A key value pair.
" - }, - "KeyValueList":{ - "type":"list", - "member":{"shape":"KeyValue"} - }, - "ListBootstrapActionsInput":{ - "type":"structure", - "required":["ClusterId"], - "members":{ - "ClusterId":{ - "shape":"ClusterId", - "documentation":"The cluster identifier for the bootstrap actions to list .
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve .
" - } - }, - "documentation":"This input determines which bootstrap actions to retrieve.
" - }, - "ListBootstrapActionsOutput":{ - "type":"structure", - "members":{ - "BootstrapActions":{ - "shape":"CommandList", - "documentation":"The bootstrap actions associated with the cluster .
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve .
" - } - }, - "documentation":"This output contains the boostrap actions detail .
" - }, - "ListClustersInput":{ - "type":"structure", - "members":{ - "CreatedAfter":{ - "shape":"Date", - "documentation":"The creation date and time beginning value filter for listing clusters .
" - }, - "CreatedBefore":{ - "shape":"Date", - "documentation":"The creation date and time end value filter for listing clusters .
" - }, - "ClusterStates":{ - "shape":"ClusterStateList", - "documentation":"The cluster state filters to apply when listing clusters.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This input determines how the ListClusters action filters the list of clusters that it returns.
" - }, - "ListClustersOutput":{ - "type":"structure", - "members":{ - "Clusters":{ - "shape":"ClusterSummaryList", - "documentation":"The list of clusters for the account based on the given filters.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
" - }, - "ListInstanceGroupsInput":{ - "type":"structure", - "required":["ClusterId"], - "members":{ - "ClusterId":{ - "shape":"ClusterId", - "documentation":"The identifier of the cluster for which to list the instance groups.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This input determines which instance groups to retrieve.
" - }, - "ListInstanceGroupsOutput":{ - "type":"structure", - "members":{ - "InstanceGroups":{ - "shape":"InstanceGroupList", - "documentation":"The list of instance groups for the cluster and given filters.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This input determines which instance groups to retrieve.
" - }, - "ListInstancesInput":{ - "type":"structure", - "required":["ClusterId"], - "members":{ - "ClusterId":{ - "shape":"ClusterId", - "documentation":"The identifier of the cluster for which to list the instances.
" - }, - "InstanceGroupId":{ - "shape":"InstanceGroupId", - "documentation":"The identifier of the instance group for which to list the instances.
" - }, - "InstanceGroupTypes":{ - "shape":"InstanceGroupTypeList", - "documentation":"The type of instance group for which to list the instances.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This input determines which instances to list.
" - }, - "ListInstancesOutput":{ - "type":"structure", - "members":{ - "Instances":{ - "shape":"InstanceList", - "documentation":"The list of instances for the cluster and given filters.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This output contains the list of instances.
" - }, - "ListStepsInput":{ - "type":"structure", - "required":["ClusterId"], - "members":{ - "ClusterId":{ - "shape":"ClusterId", - "documentation":"The identifier of the cluster for which to list the steps.
" - }, - "StepStates":{ - "shape":"StepStateList", - "documentation":"The filter to limit the step list based on certain states.
" - }, - "StepIds":{ - "shape":"XmlStringList", - "documentation":"The filter to limit the step list based on the identifier of the steps.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This input determines which steps to list.
" - }, - "ListStepsOutput":{ - "type":"structure", - "members":{ - "Steps":{ - "shape":"StepSummaryList", - "documentation":"The filtered list of steps for the cluster.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"The pagination token that indicates the next set of results to retrieve.
" - } - }, - "documentation":"This output contains the list of steps.
" - }, - "Marker":{"type":"string"}, - "MarketType":{ - "type":"string", - "enum":[ - "ON_DEMAND", - "SPOT" - ] - }, - "ModifyInstanceGroupsInput":{ - "type":"structure", - "members":{ - "InstanceGroups":{ - "shape":"InstanceGroupModifyConfigList", - "documentation":"Instance groups to change.
" - } - }, - "documentation":"Change the size of some instance groups.
" - }, - "NewSupportedProductsList":{ - "type":"list", - "member":{"shape":"SupportedProductConfig"} - }, - "PlacementType":{ - "type":"structure", - "required":["AvailabilityZone"], - "members":{ - "AvailabilityZone":{ - "shape":"XmlString", - "documentation":"The Amazon EC2 Availability Zone for the job flow.
" - } - }, - "documentation":"The Amazon EC2 location for the job flow.
" - }, - "RemoveTagsInput":{ - "type":"structure", - "required":[ - "ResourceId", - "TagKeys" - ], - "members":{ - "ResourceId":{ - "shape":"ResourceId", - "documentation":"The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.
" - }, - "TagKeys":{ - "shape":"StringList", - "documentation":"A list of tag keys to remove from a resource.
" - } - }, - "documentation":"This input identifies a cluster and a list of tags to remove.
" - }, - "RemoveTagsOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"This output indicates the result of removing tags from a resource.
" - }, - "ResourceId":{"type":"string"}, - "RunJobFlowInput":{ - "type":"structure", - "required":[ - "Name", - "Instances" - ], - "members":{ - "Name":{ - "shape":"XmlStringMaxLen256", - "documentation":"The name of the job flow.
" - }, - "LogUri":{ - "shape":"XmlString", - "documentation":"The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
" - }, - "AdditionalInfo":{ - "shape":"XmlString", - "documentation":"A JSON string for selecting additional features.
" - }, - "AmiVersion":{ - "shape":"XmlStringMaxLen256", - "documentation":"The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:
If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.
For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
" - }, - "Instances":{ - "shape":"JobFlowInstancesConfig", - "documentation":"A specification of the number and type of Amazon EC2 instances on which to run the job flow.
" - }, - "Steps":{ - "shape":"StepConfigList", - "documentation":"A list of steps to be executed by the job flow.
" - }, - "BootstrapActions":{ - "shape":"BootstrapActionConfigList", - "documentation":"A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.
" - }, - "SupportedProducts":{ - "shape":"SupportedProductsList", - "documentation":"A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:
A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:
Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it.
An IAM role for the job flow. The EC2 instances of the job flow assume this role. The default role is EMRJobflowDefault. In order to use the default role, you must have already created it using the CLI.
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
" - } - }, - "documentation":"Input to the RunJobFlow operation.
" - }, - "RunJobFlowOutput":{ - "type":"structure", - "members":{ - "JobFlowId":{ - "shape":"XmlStringMaxLen256", - "documentation":"An unique identifier for the job flow.
" - } - }, - "documentation":"The result of the RunJobFlow operation.
" - }, - "ScriptBootstrapActionConfig":{ - "type":"structure", - "required":["Path"], - "members":{ - "Path":{ - "shape":"XmlString", - "documentation":"Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.
" - }, - "Args":{ - "shape":"XmlStringList", - "documentation":"A list of command line arguments to pass to the bootstrap action script.
" - } - }, - "documentation":"Configuration of the script to run during a bootstrap action.
" - }, - "SecurityGroupsList":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen256"} - }, - "SetTerminationProtectionInput":{ - "type":"structure", - "required":[ - "JobFlowIds", - "TerminationProtected" - ], - "members":{ - "JobFlowIds":{ - "shape":"XmlStringList", - "documentation":"A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
" - }, - "TerminationProtected":{ - "shape":"Boolean", - "documentation":"A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.
" - } - }, - "documentation":"The input argument to the TerminationProtection operation.
" - }, - "SetVisibleToAllUsersInput":{ - "type":"structure", - "required":[ - "JobFlowIds", - "VisibleToAllUsers" - ], - "members":{ - "JobFlowIds":{ - "shape":"XmlStringList", - "documentation":"Identifiers of the job flows to receive the new visibility setting.
" - }, - "VisibleToAllUsers":{ - "shape":"Boolean", - "documentation":"Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it.
" - } - }, - "documentation":"The input to the SetVisibleToAllUsers action.
" - }, - "Step":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"StepId", - "documentation":"The identifier of the cluster step.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the cluster step.
" - }, - "Config":{ - "shape":"HadoopStepConfig", - "documentation":"The Hadoop job configuration of the cluster step.
" - }, - "ActionOnFailure":{ - "shape":"ActionOnFailure", - "documentation":"This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
" - }, - "Status":{ - "shape":"StepStatus", - "documentation":"The current execution status details of the cluster step.
" - } - }, - "documentation":"This represents a step in a cluster.
" - }, - "StepConfig":{ - "type":"structure", - "required":[ - "Name", - "HadoopJarStep" - ], - "members":{ - "Name":{ - "shape":"XmlStringMaxLen256", - "documentation":"The name of the job flow step.
" - }, - "ActionOnFailure":{ - "shape":"ActionOnFailure", - "documentation":"The action to take if the job flow step fails.
" - }, - "HadoopJarStep":{ - "shape":"HadoopJarStepConfig", - "documentation":"The JAR file used for the job flow step.
" - } - }, - "documentation":"Specification of a job flow step.
" - }, - "StepConfigList":{ - "type":"list", - "member":{"shape":"StepConfig"} - }, - "StepDetail":{ - "type":"structure", - "required":[ - "StepConfig", - "ExecutionStatusDetail" - ], - "members":{ - "StepConfig":{ - "shape":"StepConfig", - "documentation":"The step configuration.
" - }, - "ExecutionStatusDetail":{ - "shape":"StepExecutionStatusDetail", - "documentation":"The description of the step status.
" - } - }, - "documentation":"Combines the execution state and configuration of a step.
" - }, - "StepDetailList":{ - "type":"list", - "member":{"shape":"StepDetail"} - }, - "StepExecutionState":{ - "type":"string", - "enum":[ - "PENDING", - "RUNNING", - "CONTINUE", - "COMPLETED", - "CANCELLED", - "FAILED", - "INTERRUPTED" - ] - }, - "StepExecutionStatusDetail":{ - "type":"structure", - "required":[ - "State", - "CreationDateTime" - ], - "members":{ - "State":{ - "shape":"StepExecutionState", - "documentation":"The state of the job flow step.
" - }, - "CreationDateTime":{ - "shape":"Date", - "documentation":"The creation date and time of the step.
" - }, - "StartDateTime":{ - "shape":"Date", - "documentation":"The start date and time of the step.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The completion date and time of the step.
" - }, - "LastStateChangeReason":{ - "shape":"XmlString", - "documentation":"A description of the step's current state.
" - } - }, - "documentation":"The execution state of a step.
" - }, - "StepId":{"type":"string"}, - "StepIdsList":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen256"} - }, - "StepState":{ - "type":"string", - "enum":[ - "PENDING", - "RUNNING", - "COMPLETED", - "CANCELLED", - "FAILED", - "INTERRUPTED" - ] - }, - "StepStateChangeReason":{ - "type":"structure", - "members":{ - "Code":{ - "shape":"StepStateChangeReasonCode", - "documentation":"The programmable code for the state change reason.
" - }, - "Message":{ - "shape":"String", - "documentation":"The descriptive message for the state change reason.
" - } - }, - "documentation":"The details of the step state change reason.
" - }, - "StepStateChangeReasonCode":{ - "type":"string", - "enum":["NONE"] - }, - "StepStateList":{ - "type":"list", - "member":{"shape":"StepState"} - }, - "StepStatus":{ - "type":"structure", - "members":{ - "State":{ - "shape":"StepState", - "documentation":"The execution state of the cluster step.
" - }, - "StateChangeReason":{ - "shape":"StepStateChangeReason", - "documentation":"The reason for the step execution status change.
" - }, - "Timeline":{ - "shape":"StepTimeline", - "documentation":"The timeline of the cluster step status over time.
" - } - }, - "documentation":"The execution status details of the cluster step.
" - }, - "StepSummary":{ - "type":"structure", - "members":{ - "Id":{ - "shape":"StepId", - "documentation":"The identifier of the cluster step.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name of the cluster step.
" - }, - "Config":{ - "shape":"HadoopStepConfig", - "documentation":"The Hadoop job configuration of the cluster step.
" - }, - "ActionOnFailure":{ - "shape":"ActionOnFailure", - "documentation":"This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
" - }, - "Status":{ - "shape":"StepStatus", - "documentation":"The current execution status details of the cluster step.
" - } - }, - "documentation":"The summary of the cluster step.
" - }, - "StepSummaryList":{ - "type":"list", - "member":{"shape":"StepSummary"} - }, - "StepTimeline":{ - "type":"structure", - "members":{ - "CreationDateTime":{ - "shape":"Date", - "documentation":"The date and time when the cluster step was created.
" - }, - "StartDateTime":{ - "shape":"Date", - "documentation":"The date and time when the cluster step execution started.
" - }, - "EndDateTime":{ - "shape":"Date", - "documentation":"The date and time when the cluster step execution completed or failed.
" - } - }, - "documentation":"The timeline of the cluster step lifecycle.
" - }, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "StringMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "SupportedProductConfig":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"XmlStringMaxLen256", - "documentation":"The name of the product configuration.
" - }, - "Args":{ - "shape":"XmlStringList", - "documentation":"The list of user-supplied arguments.
" - } - }, - "documentation":"The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.
" - }, - "SupportedProductsList":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen256"} - }, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"A user-defined key, which is the minimum required information for a valid tag. For more information, see Tagging Amazon EMR Resources.
" - }, - "Value":{ - "shape":"String", - "documentation":"A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources.
" - } - }, - "documentation":"A key/value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clu\\ sters to track your Amazon EMR resource allocation costs. For more information, see Tagging Amazon EMR Resources.
" - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "TerminateJobFlowsInput":{ - "type":"structure", - "required":["JobFlowIds"], - "members":{ - "JobFlowIds":{ - "shape":"XmlStringList", - "documentation":"A list of job flows to be shutdown.
" - } - }, - "documentation":"Input to the TerminateJobFlows operation.
" - }, - "XmlString":{ - "type":"string", - "min":0, - "max":10280, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringList":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "XmlStringMaxLen256":{ - "type":"string", - "min":0, - "max":256, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.paginators.json deleted file mode 100644 index 8092b5984e..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.paginators.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "pagination": { - "ListBootstrapActions": { - "input_token": "Marker", - "output_token": "Marker", - "result_key": "BootstrapActions" - }, - "ListClusters": { - "input_token": "Marker", - "output_token": "Marker", - "result_key": "Clusters" - }, - "ListInstanceGroups": { - "input_token": "Marker", - "output_token": "Marker", - "result_key": "InstanceGroups" - }, - "ListInstances": { - "input_token": "Marker", - "output_token": "Marker", - "result_key": "Instances" - }, - "ListSteps": { - "input_token": "Marker", - "output_token": "Marker", - "result_key": "Steps" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.waiters.json deleted file mode 100644 index 9c68bdda0c..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/emr/2009-03-31.waiters.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "version": 2, - "waiters": { - "ClusterRunning": { - "delay": 30, - "operation": "DescribeCluster", - "maxAttempts": 60, - "acceptors": [ - { - "state": "success", - "matcher": "path", - "argument": "Cluster.Status.State", - "expected": "RUNNING" - }, - { - "state": "success", - "matcher": "path", - "argument": "Cluster.Status.State", - "expected": "WAITING" - }, - { - "state": "failure", - "matcher": "path", - "argument": "Cluster.Status.State", - "expected": "TERMINATING" - }, - { - "state": "failure", - "matcher": "path", - "argument": "Cluster.Status.State", - "expected": "TERMINATED" - }, - { - "state": "failure", - "matcher": "path", - "argument": "Cluster.Status.State", - "expected": "TERMINATED_WITH_ERRORS" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/glacier/2012-06-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/glacier/2012-06-01.normal.json deleted file mode 100644 index 4c831e705e..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/glacier/2012-06-01.normal.json +++ /dev/null @@ -1,2132 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-06-01", - "checksumFormat":"sha256", - "endpointPrefix":"glacier", - "serviceFullName":"Amazon Glacier", - "signatureVersion":"v4", - "protocol":"rest-json" - }, - "documentation":"Amazon Glacier is a storage solution for \"cold data.\"
Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.
Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to Amazon Simple Storage Service (Amazon S3).
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.
If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide:
What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.
Provides options to abort a multipart upload identified by the upload ID.
For information about the underlying REST API, go to Abort Multipart Upload. For conceptual information, go to Working with Archives in Amazon Glacier.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation aborts a multipart upload identified by the upload ID.
After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.
" - }, - "CompleteMultipartUpload":{ - "name":"CompleteMultipartUpload", - "http":{ - "method":"POST", - "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", - "responseCode":201 - }, - "input":{ - "shape":"CompleteMultipartUploadInput", - "documentation":"Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.
" - }, - "output":{ - "shape":"ArchiveCreationOutput", - "documentation":"Contains the Amazon Glacier response to your request.
For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.
Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.
Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.
" - }, - "CreateVault":{ - "name":"CreateVault", - "http":{ - "method":"PUT", - "requestUri":"/{accountId}/vaults/{vaultName}", - "responseCode":201 - }, - "input":{ - "shape":"CreateVaultInput", - "documentation":"Provides options to create a vault.
" - }, - "output":{ - "shape":"CreateVaultOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if the request results in a vault or account limit being exceeded.
" - } - ], - "documentation":"This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.
You must use the following guidelines when naming a vault.
Names can be between 1 and 255 characters long.
Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.
" - }, - "DeleteArchive":{ - "name":"DeleteArchive", - "http":{ - "method":"DELETE", - "requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteArchiveInput", - "documentation":"Provides options for deleting an archive from an Amazon Glacier vault.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:
This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.
" - }, - "DeleteVault":{ - "name":"DeleteVault", - "http":{ - "method":"DELETE", - "requestUri":"/{accountId}/vaults/{vaultName}", - "responseCode":204 - }, - "input":{ - "shape":"DeleteVaultInput", - "documentation":"Provides options for deleting a vault from Amazon Glacier.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide.
" - }, - "DeleteVaultNotifications":{ - "name":"DeleteVaultNotifications", - "http":{ - "method":"DELETE", - "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", - "responseCode":204 - }, - "input":{ - "shape":"DeleteVaultNotificationsInput", - "documentation":"Provides options for deleting a vault notification configuration from an Amazon Glacier vault.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation deletes the notification configuration set for a vault. The operation is eventually consistent;that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.
" - }, - "DescribeJob":{ - "name":"DescribeJob", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}" - }, - "input":{ - "shape":"DescribeJobInput", - "documentation":"Provides options for retrieving a job description.
" - }, - "output":{ - "shape":"GlacierJobDescription", - "documentation":"Describes an Amazon Glacier job.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob.
This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.
A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For information about the underlying REST API, go to Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide.
" - }, - "DescribeVault":{ - "name":"DescribeVault", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}" - }, - "input":{ - "shape":"DescribeVaultInput", - "documentation":"Provides options for retrieving metadata for a specific vault in Amazon Glacier.
" - }, - "output":{ - "shape":"DescribeVaultOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide.
" - }, - "GetDataRetrievalPolicy":{ - "name":"GetDataRetrievalPolicy", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/policies/data-retrieval" - }, - "input":{"shape":"GetDataRetrievalPolicyInput"}, - "output":{"shape":"GetDataRetrievalPolicyOutput"}, - "errors":[ - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ] - }, - "GetJobOutput":{ - "name":"GetJobOutput", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" - }, - "input":{ - "shape":"GetJobOutputInput", - "documentation":"Provides options for downloading output of an Amazon Glacier job.
" - }, - "output":{ - "shape":"GetJobOutputOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
If the job output is large, then you can use the Range request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:
Download a 128 MB chunk of output by specifying the appropriate byte range using the Range header.
Along with the data, the response includes a checksum of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Downloading a Vault Inventory, Downloading an Archive, and Get Job Output
" - }, - "GetVaultNotifications":{ - "name":"GetVaultNotifications", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration" - }, - "input":{ - "shape":"GetVaultNotificationsInput", - "documentation":"Provides options for retrieving the notification configuration set on an Amazon Glacier vault.
" - }, - "output":{ - "shape":"GetVaultNotificationsOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation retrieves the notification-configuration subresource of the specified vault.
For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.
" - }, - "InitiateJob":{ - "name":"InitiateJob", - "http":{ - "method":"POST", - "requestUri":"/{accountId}/vaults/{vaultName}/jobs", - "responseCode":202 - }, - "input":{ - "shape":"InitiateJobInput", - "documentation":"Provides options for initiating an Amazon Glacier job.
" - }, - "output":{ - "shape":"InitiateJobOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"PolicyEnforcedException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).
Retrieving data from Amazon Glacier is a two-step process:
Initiate a retrieval job.
After the job completes, download the bytes.
The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.
The job must complete before you can get its output. To determine when a job is complete, you have the following options:
Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications.
Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.
The information you get via notification is same that you get by calling DescribeJob.
If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
About the Vault Inventory
Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.
Range Inventory Retrieval
You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.
Filtering by Archive Creation Date
You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate, you will retrieve the inventory for all archives created on or after the StartDate. If you only provide the EndDate without the StartDate, you will get back the inventory for all archives created before the EndDate.
Limiting Inventory Items per Retrieval
You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit. If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.
You can use the Limit parameter together with the date range parameters.
About Ranged Archive Retrieval
You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Initiate a Job and Downloading a Vault Inventory
" - }, - "InitiateMultipartUpload":{ - "name":"InitiateMultipartUpload", - "http":{ - "method":"POST", - "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads", - "responseCode":201 - }, - "input":{ - "shape":"InitiateMultipartUploadInput", - "documentation":"Provides options for initiating a multipart upload to an Amazon Glacier vault.
" - }, - "output":{ - "shape":"InitiateMultipartUploadOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).
When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.
Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.
You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.
After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.
" - }, - "ListJobs":{ - "name":"ListJobs", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}/jobs" - }, - "input":{ - "shape":"ListJobsInput", - "documentation":"Provides options for retrieving a job list for an Amazon Glacier vault.
" - }, - "output":{ - "shape":"ListJobsOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.
Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.
To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.
This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of jobs that begins at a specific job, set the marker request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the limit parameter in the request.
Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For the underlying REST API, go to List Jobs
" - }, - "ListMultipartUploads":{ - "name":"ListMultipartUploads", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads" - }, - "input":{ - "shape":"ListMultipartUploadsInput", - "documentation":"Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.
" - }, - "output":{ - "shape":"ListMultipartUploadsOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.
The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.
Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.
" - }, - "ListParts":{ - "name":"ListParts", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" - }, - "input":{ - "shape":"ListPartsInput", - "documentation":"Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
" - }, - "output":{ - "shape":"ListPartsOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.
The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide.
" - }, - "ListVaults":{ - "name":"ListVaults", - "http":{ - "method":"GET", - "requestUri":"/{accountId}/vaults" - }, - "input":{ - "shape":"ListVaultsInput", - "documentation":"Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
" - }, - "output":{ - "shape":"ListVaultsOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 1,000 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide.
" - }, - "SetDataRetrievalPolicy":{ - "name":"SetDataRetrievalPolicy", - "http":{ - "method":"PUT", - "requestUri":"/{accountId}/policies/data-retrieval", - "responseCode":204 - }, - "input":{"shape":"SetDataRetrievalPolicyInput"}, - "errors":[ - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ] - }, - "SetVaultNotifications":{ - "name":"SetVaultNotifications", - "http":{ - "method":"PUT", - "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", - "responseCode":204 - }, - "input":{ - "shape":"SetVaultNotificationsInput", - "documentation":"Provides options to configure notifications that will be sent when specific events happen to a vault.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.
To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.
Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.
" - }, - "UploadArchive":{ - "name":"UploadArchive", - "http":{ - "method":"POST", - "requestUri":"/{accountId}/vaults/{vaultName}/archives", - "responseCode":201 - }, - "input":{ - "shape":"UploadArchiveInput", - "documentation":"Provides options to add an archive to a vault.
" - }, - "output":{ - "shape":"ArchiveCreationOutput", - "documentation":"Contains the Amazon Glacier response to your request.
For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"RequestTimeoutException", - "error":{"httpStatusCode":408}, - "exception":true, - "documentation":"Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response.
You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.
" - }, - "UploadMultipartPart":{ - "name":"UploadMultipartPart", - "http":{ - "method":"PUT", - "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", - "responseCode":204 - }, - "input":{ - "shape":"UploadMultipartPartInput", - "documentation":"Provides options to upload a part of an archive in a multipart upload operation.
" - }, - "output":{ - "shape":"UploadMultipartPartOutput", - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "errors":[ - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"MissingParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - { - "shape":"RequestTimeoutException", - "error":{"httpStatusCode":408}, - "exception":true, - "documentation":"Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
" - }, - { - "shape":"ServiceUnavailableException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.
Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.
" - } - }, - "shapes":{ - "AbortMultipartUploadInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "uploadId":{ - "shape":"string", - "location":"uri", - "locationName":"uploadId", - "documentation":"The upload ID of the multipart upload to delete.
" - } - }, - "documentation":"Provides options to abort a multipart upload identified by the upload ID.
For information about the underlying REST API, go to Abort Multipart Upload. For conceptual information, go to Working with Archives in Amazon Glacier.
", - "required":[ - "accountId", - "vaultName", - "uploadId" - ] - }, - "ActionCode":{ - "type":"string", - "enum":[ - "ArchiveRetrieval", - "InventoryRetrieval" - ] - }, - "ArchiveCreationOutput":{ - "type":"structure", - "members":{ - "location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The relative URI path of the newly added archive resource.
" - }, - "checksum":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-sha256-tree-hash", - "documentation":"The checksum of the archive computed by Amazon Glacier.
" - }, - "archiveId":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-archive-id", - "documentation":"The ID of the archive. This value is also included as part of the location.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier.
" - }, - "CompleteMultipartUploadInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "uploadId":{ - "shape":"string", - "location":"uri", - "locationName":"uploadId", - "documentation":"The upload ID of the multipart upload.
" - }, - "archiveSize":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-archive-size", - "documentation":"The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.
" - }, - "checksum":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-sha256-tree-hash", - "documentation":"The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.
" - } - }, - "documentation":"Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.
", - "required":[ - "accountId", - "vaultName", - "uploadId" - ] - }, - "CreateVaultInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - } - }, - "documentation":"Provides options to create a vault.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "CreateVaultOutput":{ - "type":"structure", - "members":{ - "location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The URI of the vault that was created.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "DataRetrievalPolicy":{ - "type":"structure", - "members":{ - "Rules":{"shape":"DataRetrievalRulesList"} - } - }, - "DataRetrievalRule":{ - "type":"structure", - "members":{ - "Strategy":{"shape":"string"}, - "BytesPerHour":{"shape":"NullableLong"} - } - }, - "DataRetrievalRulesList":{ - "type":"list", - "member":{"shape":"DataRetrievalRule"} - }, - "DateTime":{"type":"string"}, - "DeleteArchiveInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "archiveId":{ - "shape":"string", - "location":"uri", - "locationName":"archiveId", - "documentation":"The ID of the archive to delete.
" - } - }, - "documentation":"Provides options for deleting an archive from an Amazon Glacier vault.
", - "required":[ - "accountId", - "vaultName", - "archiveId" - ] - }, - "DeleteVaultInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - } - }, - "documentation":"Provides options for deleting a vault from Amazon Glacier.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "DeleteVaultNotificationsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - } - }, - "documentation":"Provides options for deleting a vault notification configuration from an Amazon Glacier vault.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "DescribeJobInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "jobId":{ - "shape":"string", - "location":"uri", - "locationName":"jobId", - "documentation":"The ID of the job to describe.
" - } - }, - "documentation":"Provides options for retrieving a job description.
", - "required":[ - "accountId", - "vaultName", - "jobId" - ] - }, - "DescribeVaultInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - } - }, - "documentation":"Provides options for retrieving metadata for a specific vault in Amazon Glacier.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "DescribeVaultOutput":{ - "type":"structure", - "members":{ - "VaultARN":{ - "shape":"string", - "documentation":"The Amazon Resource Name (ARN) of the vault.
" - }, - "VaultName":{ - "shape":"string", - "documentation":"The name of the vault.
" - }, - "CreationDate":{ - "shape":"string", - "documentation":"The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".
" - }, - "LastInventoryDate":{ - "shape":"string", - "documentation":"The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".
" - }, - "NumberOfArchives":{ - "shape":"long", - "documentation":"The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.
Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "GetDataRetrievalPolicyInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId" - } - }, - "required":["accountId"] - }, - "GetDataRetrievalPolicyOutput":{ - "type":"structure", - "members":{ - "Policy":{"shape":"DataRetrievalPolicy"} - } - }, - "GetJobOutputInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "jobId":{ - "shape":"string", - "location":"uri", - "locationName":"jobId", - "documentation":"The job ID whose data is downloaded.
" - }, - "range":{ - "shape":"string", - "location":"header", - "locationName":"Range", - "documentation":"The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify \"Range: bytes=0-1048575\". By default, this operation downloads the entire output.
" - } - }, - "documentation":"Provides options for downloading output of an Amazon Glacier job.
", - "required":[ - "accountId", - "vaultName", - "jobId" - ] - }, - "GetJobOutputOutput":{ - "type":"structure", - "members":{ - "body":{ - "shape":"Stream", - "documentation":"The job data, either archive data or inventory data.
" - }, - "checksum":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-sha256-tree-hash", - "documentation":"The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:
The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
" - }, - "contentRange":{ - "shape":"string", - "location":"header", - "locationName":"Content-Range", - "documentation":"The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
" - }, - "acceptRanges":{ - "shape":"string", - "location":"header", - "locationName":"Accept-Ranges", - "documentation":"Indicates the range units accepted. For more information, go to RFC2616.
" - }, - "contentType":{ - "shape":"string", - "location":"header", - "locationName":"Content-Type", - "documentation":"The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.
" - }, - "archiveDescription":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-archive-description", - "documentation":"The description of an archive.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
", - "payload":"body" - }, - "GetVaultNotificationsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - } - }, - "documentation":"Provides options for retrieving the notification configuration set on an Amazon Glacier vault.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "GetVaultNotificationsOutput":{ - "type":"structure", - "members":{ - "vaultNotificationConfig":{ - "shape":"VaultNotificationConfig", - "documentation":"Returns the notification configuration set on the vault.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
", - "payload":"vaultNotificationConfig" - }, - "GlacierJobDescription":{ - "type":"structure", - "members":{ - "JobId":{ - "shape":"string", - "documentation":"An opaque string that identifies an Amazon Glacier job.
" - }, - "JobDescription":{ - "shape":"string", - "documentation":"The job description you provided when you initiated the job.
" - }, - "Action":{ - "shape":"ActionCode", - "documentation":"The job type. It is either ArchiveRetrieval or InventoryRetrieval.
" - }, - "ArchiveId":{ - "shape":"string", - "documentation":"For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
" - }, - "VaultARN":{ - "shape":"string", - "documentation":"The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
" - }, - "CreationDate":{ - "shape":"string", - "documentation":"The UTC date when the job was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".
" - }, - "Completed":{ - "shape":"boolean", - "documentation":"The job status. When a job is completed, you get the job's output.
" - }, - "StatusCode":{ - "shape":"StatusCode", - "documentation":"The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
" - }, - "StatusMessage":{ - "shape":"string", - "documentation":"A friendly message that describes the job status.
" - }, - "ArchiveSizeInBytes":{ - "shape":"Size", - "documentation":"For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.
" - }, - "InventorySizeInBytes":{ - "shape":"Size", - "documentation":"For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
" - }, - "SNSTopic":{ - "shape":"string", - "documentation":"An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
" - }, - "CompletionDate":{ - "shape":"string", - "documentation":"The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
" - }, - "SHA256TreeHash":{ - "shape":"string", - "documentation":"For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
" - }, - "RetrievalByteRange":{ - "shape":"string", - "documentation":"The retrieved byte range for archive retrieval jobs in the form \"StartByteValue-EndByteValue\" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
" - }, - "InventoryRetrievalParameters":{ - "shape":"InventoryRetrievalJobDescription", - "documentation":"Parameters used for range inventory retrieval.
" - } - }, - "documentation":"Describes an Amazon Glacier job.
" - }, - "InitiateJobInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "jobParameters":{ - "shape":"JobParameters", - "documentation":"Provides options for specifying job information.
" - } - }, - "documentation":"Provides options for initiating an Amazon Glacier job.
", - "required":[ - "accountId", - "vaultName" - ], - "payload":"jobParameters" - }, - "InitiateJobOutput":{ - "type":"structure", - "members":{ - "location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The relative URI path of the job.
" - }, - "jobId":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-job-id", - "documentation":"The ID of the job.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "InitiateMultipartUploadInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "archiveDescription":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-archive-description", - "documentation":"The archive description that you are uploading in parts.
The part size must be a megabyte (1024 KB) multiplied by a power of 2—for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).
" - }, - "partSize":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-part-size", - "documentation":"The size of each part except the last, in bytes. The last part can be smaller than this part size.
" - } - }, - "documentation":"Provides options for initiating a multipart upload to an Amazon Glacier vault.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "InitiateMultipartUploadOutput":{ - "type":"structure", - "members":{ - "location":{ - "shape":"string", - "location":"header", - "locationName":"Location", - "documentation":"The relative URI path of the multipart upload ID Amazon Glacier created.
" - }, - "uploadId":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-multipart-upload-id", - "documentation":"The ID of the multipart upload. This value is also included as part of the location.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "type":{ - "shape":"string", - "documentation":"Client
" - }, - "code":{ - "shape":"string", - "documentation":"400 Bad Request
" - }, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - "InventoryRetrievalJobDescription":{ - "type":"structure", - "members":{ - "Format":{ - "shape":"string", - "documentation":"The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are \"CSV\" and \"JSON\".
" - }, - "StartDate":{ - "shape":"DateTime", - "documentation":"The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
" - }, - "EndDate":{ - "shape":"DateTime", - "documentation":"The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
" - }, - "Limit":{ - "shape":"string", - "documentation":"Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
" - }, - "Marker":{ - "shape":"string", - "documentation":"An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.
Describes the options for a range inventory retrieval job.
" - }, - "InventoryRetrievalJobInput":{ - "type":"structure", - "members":{ - "StartDate":{ - "shape":"string", - "documentation":"The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
" - }, - "EndDate":{ - "shape":"string", - "documentation":"The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
" - }, - "Limit":{ - "shape":"string", - "documentation":"Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.
" - }, - "Marker":{ - "shape":"string", - "documentation":"An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null.
Provides options for specifying a range inventory retrieval job.
" - }, - "JobList":{ - "type":"list", - "member":{"shape":"GlacierJobDescription"} - }, - "JobParameters":{ - "type":"structure", - "members":{ - "Format":{ - "shape":"string", - "documentation":"When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are \"CSV\" and \"JSON\".
" - }, - "Type":{ - "shape":"string", - "documentation":"The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are \"archive-retrieval\" and \"inventory-retrieval\".
" - }, - "ArchiveId":{ - "shape":"string", - "documentation":"The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
" - }, - "SNSTopic":{ - "shape":"string", - "documentation":"The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
" - }, - "RetrievalByteRange":{ - "shape":"string", - "documentation":"The byte range to retrieve for an archive retrieval. in the form \"StartByteValue-EndByteValue\" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
" - }, - "InventoryRetrievalParameters":{ - "shape":"InventoryRetrievalJobInput", - "documentation":"Input parameters used for range inventory retrieval.
" - } - }, - "documentation":"Provides options for defining a job.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "type":{ - "shape":"string", - "documentation":"Client
" - }, - "code":{ - "shape":"string", - "documentation":"400 Bad Request
" - }, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if the request results in a vault or account limit being exceeded.
" - }, - "ListJobsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "limit":{ - "shape":"string", - "location":"querystring", - "locationName":"limit", - "documentation":"Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
" - }, - "marker":{ - "shape":"string", - "location":"querystring", - "locationName":"marker", - "documentation":"An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
" - }, - "statuscode":{ - "shape":"string", - "location":"querystring", - "locationName":"statuscode", - "documentation":"Specifies the type of job status to return. You can specify the following values: \"InProgress\", \"Succeeded\", or \"Failed\".
" - }, - "completed":{ - "shape":"string", - "location":"querystring", - "locationName":"completed", - "documentation":"Specifies the state of the jobs to return. You can specify true or false.
Provides options for retrieving a job list for an Amazon Glacier vault.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "ListJobsOutput":{ - "type":"structure", - "members":{ - "JobList":{ - "shape":"JobList", - "documentation":"A list of job objects. Each job object contains metadata describing the job.
" - }, - "Marker":{ - "shape":"string", - "documentation":"An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is null.
Contains the Amazon Glacier response to your request.
" - }, - "ListMultipartUploadsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "marker":{ - "shape":"string", - "location":"querystring", - "locationName":"marker", - "documentation":"An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.
" - }, - "limit":{ - "shape":"string", - "location":"querystring", - "locationName":"limit", - "documentation":"Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.
" - } - }, - "documentation":"Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.
", - "required":[ - "accountId", - "vaultName" - ] - }, - "ListMultipartUploadsOutput":{ - "type":"structure", - "members":{ - "UploadsList":{ - "shape":"UploadsList", - "documentation":"A list of in-progress multipart uploads.
" - }, - "Marker":{ - "shape":"string", - "documentation":"An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.
Contains the Amazon Glacier response to your request.
" - }, - "ListPartsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "uploadId":{ - "shape":"string", - "location":"uri", - "locationName":"uploadId", - "documentation":"The upload ID of the multipart upload.
" - }, - "marker":{ - "shape":"string", - "location":"querystring", - "locationName":"marker", - "documentation":"An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.
" - }, - "limit":{ - "shape":"string", - "location":"querystring", - "locationName":"limit", - "documentation":"Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads.
" - } - }, - "documentation":"Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
", - "required":[ - "accountId", - "vaultName", - "uploadId" - ] - }, - "ListPartsOutput":{ - "type":"structure", - "members":{ - "MultipartUploadId":{ - "shape":"string", - "documentation":"The ID of the upload to which the parts are associated.
" - }, - "VaultARN":{ - "shape":"string", - "documentation":"The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.
" - }, - "ArchiveDescription":{ - "shape":"string", - "documentation":"The description of the archive that was specified in the Initiate Multipart Upload request.
" - }, - "PartSizeInBytes":{ - "shape":"long", - "documentation":"The part size in bytes.
" - }, - "CreationDate":{ - "shape":"string", - "documentation":"The UTC time at which the multipart upload was initiated.
" - }, - "Parts":{ - "shape":"PartList", - "documentation":"A list of the part sizes of the multipart upload.
" - }, - "Marker":{ - "shape":"string", - "documentation":"An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.
Contains the Amazon Glacier response to your request.
" - }, - "ListVaultsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
" - }, - "limit":{ - "shape":"string", - "location":"querystring", - "locationName":"limit", - "documentation":"The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
" - } - }, - "documentation":"Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
", - "required":["accountId"] - }, - "ListVaultsOutput":{ - "type":"structure", - "members":{ - "VaultList":{ - "shape":"VaultList", - "documentation":"List of vaults.
" - }, - "Marker":{ - "shape":"string", - "documentation":"The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "MissingParameterValueException":{ - "type":"structure", - "members":{ - "type":{ - "shape":"string", - "documentation":"Client.
" - }, - "code":{ - "shape":"string", - "documentation":"400 Bad Request
" - }, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Returned if a required header or parameter is missing from the request.
" - }, - "NotificationEventList":{ - "type":"list", - "member":{"shape":"string"} - }, - "NullableLong":{"type":"long"}, - "PartList":{ - "type":"list", - "member":{"shape":"PartListElement"} - }, - "PartListElement":{ - "type":"structure", - "members":{ - "RangeInBytes":{ - "shape":"string", - "documentation":"The byte range of a part, inclusive of the upper value of the range.
" - }, - "SHA256TreeHash":{ - "shape":"string", - "documentation":"The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.
A list of the part sizes of the multipart upload.
" - }, - "PolicyEnforcedException":{ - "type":"structure", - "members":{ - "type":{"shape":"string"}, - "code":{"shape":"string"}, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "RequestTimeoutException":{ - "type":"structure", - "members":{ - "type":{ - "shape":"string", - "documentation":"Client
" - }, - "code":{ - "shape":"string", - "documentation":"408 Request Timeout
" - }, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":408}, - "exception":true, - "documentation":"Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
" - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "type":{ - "shape":"string", - "documentation":"Client
" - }, - "code":{ - "shape":"string", - "documentation":"404 Not Found
" - }, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
" - }, - "ServiceUnavailableException":{ - "type":"structure", - "members":{ - "type":{ - "shape":"string", - "documentation":"Server
" - }, - "code":{ - "shape":"string", - "documentation":"500 Internal Server Error
" - }, - "message":{"shape":"string"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"Returned if the service cannot complete the request.
" - }, - "SetDataRetrievalPolicyInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId" - }, - "Policy":{"shape":"DataRetrievalPolicy"} - }, - "required":["accountId"] - }, - "SetVaultNotificationsInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "vaultNotificationConfig":{ - "shape":"VaultNotificationConfig", - "documentation":"Provides options for specifying notification configuration.
" - } - }, - "documentation":"Provides options to configure notifications that will be sent when specific events happen to a vault.
", - "required":[ - "accountId", - "vaultName" - ], - "payload":"vaultNotificationConfig" - }, - "Size":{"type":"long"}, - "StatusCode":{ - "type":"string", - "enum":[ - "InProgress", - "Succeeded", - "Failed" - ] - }, - "Stream":{ - "type":"blob", - "streaming":true - }, - "UploadArchiveInput":{ - "type":"structure", - "members":{ - "vaultName":{ - "shape":"string", - "location":"uri", - "locationName":"vaultName", - "documentation":"The name of the vault.
" - }, - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The optional description of the archive you are uploading.
" - }, - "checksum":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-sha256-tree-hash", - "documentation":"The SHA256 checksum (a linear hash) of the payload.
" - }, - "body":{ - "shape":"Stream", - "documentation":"The data to upload.
" - } - }, - "documentation":"Provides options to add an archive to a vault.
", - "required":[ - "vaultName", - "accountId" - ], - "payload":"body" - }, - "UploadListElement":{ - "type":"structure", - "members":{ - "MultipartUploadId":{ - "shape":"string", - "documentation":"The ID of a multipart upload.
" - }, - "VaultARN":{ - "shape":"string", - "documentation":"The Amazon Resource Name (ARN) of the vault that contains the archive.
" - }, - "ArchiveDescription":{ - "shape":"string", - "documentation":"The description of the archive that was specified in the Initiate Multipart Upload request.
" - }, - "PartSizeInBytes":{ - "shape":"long", - "documentation":"The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.
" - }, - "CreationDate":{ - "shape":"string", - "documentation":"The UTC time at which the multipart upload was initiated.
" - } - }, - "documentation":"A list of in-progress multipart uploads for a vault.
" - }, - "UploadMultipartPartInput":{ - "type":"structure", - "members":{ - "accountId":{ - "shape":"string", - "location":"uri", - "locationName":"accountId", - "documentation":"The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
The name of the vault.
" - }, - "uploadId":{ - "shape":"string", - "location":"uri", - "locationName":"uploadId", - "documentation":"The upload ID of the multipart upload.
" - }, - "checksum":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-sha256-tree-hash", - "documentation":"The SHA256 tree hash of the data being uploaded.
" - }, - "range":{ - "shape":"string", - "location":"header", - "locationName":"Content-Range", - "documentation":"Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.
" - }, - "body":{ - "shape":"Stream", - "documentation":"The data to upload.
" - } - }, - "documentation":"Provides options to upload a part of an archive in a multipart upload operation.
", - "required":[ - "accountId", - "vaultName", - "uploadId" - ], - "payload":"body" - }, - "UploadMultipartPartOutput":{ - "type":"structure", - "members":{ - "checksum":{ - "shape":"string", - "location":"header", - "locationName":"x-amz-sha256-tree-hash", - "documentation":"The SHA256 tree hash that Amazon Glacier computed for the uploaded part.
" - } - }, - "documentation":"Contains the Amazon Glacier response to your request.
" - }, - "UploadsList":{ - "type":"list", - "member":{"shape":"UploadListElement"} - }, - "VaultList":{ - "type":"list", - "member":{"shape":"DescribeVaultOutput"} - }, - "VaultNotificationConfig":{ - "type":"structure", - "members":{ - "SNSTopic":{ - "shape":"string", - "documentation":"The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).
" - }, - "Events":{ - "shape":"NotificationEventList", - "documentation":"A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.
" - } - }, - "documentation":"Represents a vault's notification configuration.
" - }, - "boolean":{"type":"boolean"}, - "httpstatus":{"type":"integer"}, - "long":{"type":"long"}, - "string":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/iam/2010-05-08.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/iam/2010-05-08.normal.json deleted file mode 100644 index 88178f68db..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/iam/2010-05-08.normal.json +++ /dev/null @@ -1,5938 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-05-08", - "endpointPrefix":"iam", - "globalEndpoint":"iam.amazonaws.com", - "serviceAbbreviation":"IAM", - "serviceFullName":"AWS Identity and Access Management", - "signatureVersion":"v4", - "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/", - "protocol":"query" - }, - "documentation":"AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.
We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
Recording API requests
IAM supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to IAM, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information, see the following:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider.
This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
" - }, - "AddRoleToInstanceProfile":{ - "name":"AddRoleToInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddRoleToInstanceProfileRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Adds the specified role to the specified instance profile. For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
" - }, - "AddUserToGroup":{ - "name":"AddUserToGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddUserToGroupRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Adds the specified user to the specified group.
" - }, - "ChangePassword":{ - "name":"ChangePassword", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ChangePasswordRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"InvalidUserTypeException", - "error":{ - "code":"InvalidUserType", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the type of user for the transaction was incorrect.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityTemporarilyUnmodifiableException", - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - }, - { - "shape":"PasswordPolicyViolationException", - "error":{ - "code":"PasswordPolicyViolation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
" - } - ], - "documentation":"Changes the password of the IAM user who is calling this action. The root account password is not affected by this action.
To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the Using IAM guide.
" - }, - "CreateAccessKey":{ - "name":"CreateAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAccessKeyRequest"}, - "output":{ - "shape":"CreateAccessKeyResponse", - "documentation":"Contains the result of a successful invocation of the CreateAccessKey action.
", - "resultWrapper":"CreateAccessKeyResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":" Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about limits on the number of keys you can create, see Limitations on IAM Entities in the Using IAM guide.
The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.
" - }, - "CreateGroup":{ - "name":"CreateGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateGroupRequest"}, - "output":{ - "shape":"CreateGroupResponse", - "documentation":"Contains the result of a successful invocation of the CreateGroup action.
", - "resultWrapper":"CreateGroupResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the Using IAM guide.
" - }, - "CreateInstanceProfile":{ - "name":"CreateInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInstanceProfileRequest"}, - "output":{ - "shape":"CreateInstanceProfileResponse", - "documentation":"Contains the result of a successful invocation of the CreateInstanceProfileaction.
", - "resultWrapper":"CreateInstanceProfileResult" - }, - "errors":[ - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.
For information about the number of instance profiles you can create, see Limitations on IAM Entities in the Using IAM guide.
" - }, - "CreateLoginProfile":{ - "name":"CreateLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLoginProfileRequest"}, - "output":{ - "shape":"CreateLoginProfileResponse", - "documentation":"Contains the result of a successful invocation of the CreateLoginProfile action.
", - "resultWrapper":"CreateLoginProfileResult" - }, - "errors":[ - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"PasswordPolicyViolationException", - "error":{ - "code":"PasswordPolicyViolation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide.
" - }, - "CreateOpenIDConnectProvider":{ - "name":"CreateOpenIDConnectProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateOpenIDConnectProviderRequest"}, - "output":{ - "shape":"CreateOpenIDConnectProviderResponse", - "documentation":"Contains the result of a successful invocation of the CreateOpenIDConnectProvider action.
", - "resultWrapper":"CreateOpenIDConnectProviderResult" - }, - "errors":[ - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider.
When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.
Contains the result of a successful invocation of the CreateRole action.
", - "resultWrapper":"CreateRoleResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - } - ], - "documentation":"Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the Using IAM guide.
The example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
" - }, - "CreateSAMLProvider":{ - "name":"CreateSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSAMLProviderRequest"}, - "output":{ - "shape":"CreateSAMLProviderResponse", - "documentation":"Contains the result of a successful invocation of the CreateSAMLProvider action.
", - "resultWrapper":"CreateSAMLProviderResult" - }, - "errors":[ - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see Giving Console Access Using SAML and Creating Temporary Security Credentials for SAML Federation in the Using Temporary Credentials guide.
" - }, - "CreateUser":{ - "name":"CreateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserRequest"}, - "output":{ - "shape":"CreateUserResponse", - "documentation":"Contains the result of a successful invocation of the CreateUser action.
", - "resultWrapper":"CreateUserResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Creates a new user for your AWS account.
For information about limitations on the number of users you can create, see Limitations on IAM Entities in the Using IAM guide.
" - }, - "CreateVirtualMFADevice":{ - "name":"CreateVirtualMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateVirtualMFADeviceRequest"}, - "output":{ - "shape":"CreateVirtualMFADeviceResponse", - "documentation":"Contains the result of a successful invocation of the CreateVirtualMFADevice action.
", - "resultWrapper":"CreateVirtualMFADeviceResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - } - ], - "documentation":"Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the Using IAM guide.
The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
" - }, - "DeleteAccessKey":{ - "name":"DeleteAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAccessKeyRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the access key associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
" - }, - "DeleteAccountAlias":{ - "name":"DeleteAccountAlias", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAccountAliasRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.
" - }, - "DeleteAccountPasswordPolicy":{ - "name":"DeleteAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the password policy for the AWS account.
" - }, - "DeleteGroup":{ - "name":"DeleteGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGroupRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"DeleteConflictException", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified group. The group must not contain any users or have any attached policies.
" - }, - "DeleteGroupPolicy":{ - "name":"DeleteGroupPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteGroupPolicyRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified policy that is associated with the specified group.
" - }, - "DeleteInstanceProfile":{ - "name":"DeleteInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInstanceProfileRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"DeleteConflictException", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified instance profile. The instance profile must not have an associated role.
For more information about instance profiles, go to About Instance Profiles.
" - }, - "DeleteLoginProfile":{ - "name":"DeleteLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLoginProfileRequest"}, - "errors":[ - { - "shape":"EntityTemporarilyUnmodifiableException", - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console.
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Deletes an IAM OpenID Connect identity provider.
Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail.
This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted.
" - }, - "DeleteRole":{ - "name":"DeleteRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRoleRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"DeleteConflictException", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.
The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified policy associated with the specified role.
" - }, - "DeleteSAMLProvider":{ - "name":"DeleteSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteSAMLProviderRequest"}, - "errors":[ - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Deletes a SAML provider.
Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail.
The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"DeleteConflictException", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified server certificate.
The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified signing certificate associated with the specified user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
" - }, - "DeleteUser":{ - "name":"DeleteUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserRequest"}, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"DeleteConflictException", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - } - ], - "documentation":"Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies.
" - }, - "DeleteUserPolicy":{ - "name":"DeleteUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserPolicyRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes the specified policy associated with the specified user.
" - }, - "DeleteVirtualMFADevice":{ - "name":"DeleteVirtualMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteVirtualMFADeviceRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"DeleteConflictException", - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Deletes a virtual MFA device.
The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"EntityTemporarilyUnmodifiableException", - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - }, - { - "shape":"InvalidAuthenticationCodeException", - "error":{ - "code":"InvalidAuthenticationCode", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the authentication code was not recognized. The error message describes the specific error.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device.
" - }, - "GenerateCredentialReport":{ - "name":"GenerateCredentialReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GenerateCredentialReportResponse", - "documentation":"Contains the result of a successful invocation of the GenerateCredentialReport action.
", - "resultWrapper":"GenerateCredentialReportResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.
" - }, - "GetAccountAuthorizationDetails":{ - "name":"GetAccountAuthorizationDetails", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAccountAuthorizationDetailsRequest"}, - "output":{ - "shape":"GetAccountAuthorizationDetailsResponse", - "documentation":"Contains the result of a successful invocation of the GetAccountAuthorizationDetails action.
", - "resultWrapper":"GetAccountAuthorizationDetailsResult" - }, - "documentation":"Retrieves information about all IAM users, groups, and roles in your account, including their relationships to one another and their attached policies. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the GetAccountPasswordPolicy action.
", - "resultWrapper":"GetAccountPasswordPolicyResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
" - }, - "GetAccountSummary":{ - "name":"GetAccountSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetAccountSummaryResponse", - "documentation":"Contains the result of a successful invocation of the GetAccountSummary action.
", - "resultWrapper":"GetAccountSummaryResult" - }, - "documentation":"Retrieves account level information about account entity usage and IAM quotas.
For information about limitations on IAM entities, see Limitations on IAM Entities in the Using IAM guide.
" - }, - "GetCredentialReport":{ - "name":"GetCredentialReport", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetCredentialReportResponse", - "documentation":"Contains the result of a successful invocation of the GetCredentialReport action.
", - "resultWrapper":"GetCredentialReportResult" - }, - "errors":[ - { - "shape":"CredentialReportNotPresentException", - "error":{ - "code":"ReportNotPresent", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
" - }, - { - "shape":"CredentialReportExpiredException", - "error":{ - "code":"ReportExpired", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the Using IAM guide.
" - }, - { - "shape":"CredentialReportNotReadyException", - "error":{ - "code":"ReportInProgress", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the credential report is still being generated.
" - } - ], - "documentation":"Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.
" - }, - "GetGroup":{ - "name":"GetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetGroupRequest"}, - "output":{ - "shape":"GetGroupResponse", - "documentation":"Contains the result of a successful invocation of the GetGroup action.
", - "resultWrapper":"GetGroupResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":" Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the GetGroupPolicy action.
", - "resultWrapper":"GetGroupPolicyResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves the specified policy document for the specified group. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
" - }, - "GetInstanceProfile":{ - "name":"GetInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetInstanceProfileRequest"}, - "output":{ - "shape":"GetInstanceProfileResponse", - "documentation":"Contains the result of a successful invocation of the GetInstanceProfile action.
", - "resultWrapper":"GetInstanceProfileResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to About Instance Profiles. For more information about ARNs, go to ARNs.
" - }, - "GetLoginProfile":{ - "name":"GetLoginProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetLoginProfileRequest"}, - "output":{ - "shape":"GetLoginProfileResponse", - "documentation":"Contains the result of a successful invocation of the GetLoginProfile action.
", - "resultWrapper":"GetLoginProfileResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":" Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.
Contains the result of a successful invocation of the GetOpenIDConnectProvider action.
", - "resultWrapper":"GetOpenIDConnectProviderResult" - }, - "errors":[ - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Returns information about the specified OpenID Connect provider.
" - }, - "GetRole":{ - "name":"GetRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRoleRequest"}, - "output":{ - "shape":"GetRoleResponse", - "documentation":"Contains the result of a successful invocation of the GetRole action.
", - "resultWrapper":"GetRoleResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to ARNs. For more information about roles, go to Working with Roles.
The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
" - }, - "GetRolePolicy":{ - "name":"GetRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRolePolicyRequest"}, - "output":{ - "shape":"GetRolePolicyResponse", - "documentation":"Contains the result of a successful invocation of the GetRolePolicy action.
", - "resultWrapper":"GetRolePolicyResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves the specified policy document for the specified role. For more information about roles, go to Working with Roles.
The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
" - }, - "GetSAMLProvider":{ - "name":"GetSAMLProvider", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSAMLProviderRequest"}, - "output":{ - "shape":"GetSAMLProviderResponse", - "documentation":"Contains the result of a successful invocation of the GetSAMLProvider action.
", - "resultWrapper":"GetSAMLProviderResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - } - ], - "documentation":"Returns the SAML provider metadocument that was uploaded when the provider was created or updated.
Contains the result of a successful invocation of the GetServerCertificate action.
", - "resultWrapper":"GetServerCertificateResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves information about the specified server certificate.
" - }, - "GetUser":{ - "name":"GetUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetUserRequest"}, - "output":{ - "shape":"GetUserResponse", - "documentation":"Contains the result of a successful invocation of the GetUser action.
", - "resultWrapper":"GetUserResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request.
" - }, - "GetUserPolicy":{ - "name":"GetUserPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetUserPolicyRequest"}, - "output":{ - "shape":"GetUserPolicyResponse", - "documentation":"Contains the result of a successful invocation of the GetUserPolicy action.
", - "resultWrapper":"GetUserPolicyResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Retrieves the specified policy document for the specified user. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
" - }, - "ListAccessKeys":{ - "name":"ListAccessKeys", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAccessKeysRequest"}, - "output":{ - "shape":"ListAccessKeysResponse", - "documentation":"Contains the result of a successful invocation of the ListAccessKeys action.
", - "resultWrapper":"ListAccessKeysResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
Contains the result of a successful invocation of the ListAccountAliases action.
", - "resultWrapper":"ListAccountAliasesResult" - }, - "documentation":"Lists the account aliases associated with the account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListGroupPolicies action.
", - "resultWrapper":"ListGroupPoliciesResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Lists the names of the policies associated with the specified group. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListGroups action.
", - "resultWrapper":"ListGroupsResult" - }, - "documentation":"Lists the groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListGroupsForUser action.
", - "resultWrapper":"ListGroupsForUserResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Lists the groups the specified user belongs to.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListInstanceProfiles action.
", - "resultWrapper":"ListInstanceProfilesResult" - }, - "documentation":"Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListInstanceProfilesForRole action.
", - "resultWrapper":"ListInstanceProfilesForRoleResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListMFADevices action.
", - "resultWrapper":"ListMFADevicesResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListOpenIDConnectProviders action.
", - "resultWrapper":"ListOpenIDConnectProvidersResult" - }, - "documentation":"Lists information about the OpenID Connect providers in the AWS account.
" - }, - "ListRolePolicies":{ - "name":"ListRolePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRolePoliciesRequest"}, - "output":{ - "shape":"ListRolePoliciesResponse", - "documentation":"Contains the result of a successful invocation of the ListRolePolicies action.
", - "resultWrapper":"ListRolePoliciesResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Lists the names of the policies associated with the specified role. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListRoles action.
", - "resultWrapper":"ListRolesResult" - }, - "documentation":"Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.
You can paginate the results using the MaxItems and Marker parameters.
The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
" - }, - "ListSAMLProviders":{ - "name":"ListSAMLProviders", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSAMLProvidersRequest"}, - "output":{ - "shape":"ListSAMLProvidersResponse", - "documentation":"Contains the result of a successful invocation of the ListSAMLProviders action.
", - "resultWrapper":"ListSAMLProvidersResult" - }, - "documentation":"Lists the SAML providers in the account.
Contains the result of a successful invocation of the ListServerCertificates action.
", - "resultWrapper":"ListServerCertificatesResult" - }, - "documentation":"Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListSigningCertificates action.
", - "resultWrapper":"ListSigningCertificatesResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
Contains the result of a successful invocation of the ListUserPolicies action.
", - "resultWrapper":"ListUserPoliciesResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Lists the names of the policies associated with the specified user. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListUsers action.
", - "resultWrapper":"ListUsersResult" - }, - "documentation":"Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
Contains the result of a successful invocation of the ListVirtualMFADevicesaction.
", - "resultWrapper":"ListVirtualMFADevicesResult" - }, - "documentation":" Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.
You can paginate the results using the MaxItems and Marker parameters.
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Adds (or updates) a policy document associated with the specified group. For information about policies, refer to Overview of Policies in the Using IAM guide.
For information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in the Using IAM guide.
PutGroupPolicy. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Adds (or updates) a policy document associated with the specified role. For information about policies, go to Overview of Policies in the Using IAM guide.
For information about limits on the policies you can associate with a role, see Limitations on IAM Entities in the Using IAM guide.
PutRolePolicy. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Adds (or updates) a policy document associated with the specified user. For information about policies, refer to Overview of Policies in the Using IAM guide.
For information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in the Using IAM guide.
PutUserPolicy. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider.
This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously.
" - }, - "RemoveRoleFromInstanceProfile":{ - "name":"RemoveRoleFromInstanceProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Removes the specified role from the specified instance profile.
For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
" - }, - "RemoveUserFromGroup":{ - "name":"RemoveUserFromGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveUserFromGroupRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Removes the specified user from the specified group.
" - }, - "ResyncMFADevice":{ - "name":"ResyncMFADevice", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ResyncMFADeviceRequest"}, - "errors":[ - { - "shape":"InvalidAuthenticationCodeException", - "error":{ - "code":"InvalidAuthenticationCode", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the authentication code was not recognized. The error message describes the specific error.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Synchronizes the specified MFA device with AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
" - }, - "UpdateAccessKey":{ - "name":"UpdateAccessKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAccessKeyRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.
If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about rotating keys, see Managing Keys and Certificates in the Using IAM guide.
" - }, - "UpdateAccountPasswordPolicy":{ - "name":"UpdateAccountPasswordPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Updates the password policy settings for the AWS account.
This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value.
For more information about using a password policy, see Managing an IAM Password Policy in the Using IAM guide.
" - }, - "UpdateAssumeRolePolicy":{ - "name":"UpdateAssumeRolePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAssumeRolePolicyRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Updates the policy that grants an entity permission to assume a role. For more information about roles, go to Working with Roles.
" - }, - "UpdateGroup":{ - "name":"UpdateGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateGroupRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Updates the name and/or the path of the specified group.
The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"PasswordPolicyViolationException", - "error":{ - "code":"PasswordPolicyViolation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Changes the password for the specified user.
Users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the Using IAM guide.
" - }, - "UpdateOpenIDConnectProviderThumbprint":{ - "name":"UpdateOpenIDConnectProviderThumbprint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateOpenIDConnectProviderThumbprintRequest"}, - "errors":[ - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":"Replaces the existing list of server certificate thumbprints with a new list.
The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the IAM provider as a principal will fail until the certificate thumbprint is updated.
UpdateOpenIDConnectProviderThumbprint action to highly-privileged users. Contains the result of a successful invocation of the UpdateSAMLProvider action.
", - "resultWrapper":"UpdateSAMLProviderResult" - }, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"InvalidInputException", - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Updates the metadata document for an existing SAML provider.
The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Updates the name and/or the path of the specified server certificate.
The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - } - ], - "documentation":"Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow.
If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about rotating certificates, see Managing Keys and Certificates in the Using IAM guide.
" - }, - "UpdateUser":{ - "name":"UpdateUser", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateUserRequest"}, - "errors":[ - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"EntityTemporarilyUnmodifiableException", - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - } - ], - "documentation":"Updates the name and/or the path of the specified user.
Contains the result of a successful invocation of the UploadServerCertificate action.
", - "resultWrapper":"UploadServerCertificateResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"MalformedCertificateException", - "error":{ - "code":"MalformedCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
" - }, - { - "shape":"KeyPairMismatchException", - "error":{ - "code":"KeyPairMismatch", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the public key certificate and the private key do not match.
" - } - ], - "documentation":"Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
For information about the number of server certificates you can upload, see Limitations on IAM Entities in the Using IAM guide.
UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide. Contains the result of a successful invocation of the UploadSigningCertificate action.
", - "resultWrapper":"UploadSigningCertificateResult" - }, - "errors":[ - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - { - "shape":"EntityAlreadyExistsException", - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"MalformedCertificateException", - "error":{ - "code":"MalformedCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
" - }, - { - "shape":"InvalidCertificateException", - "error":{ - "code":"InvalidCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the certificate is invalid.
" - }, - { - "shape":"DuplicateCertificateException", - "error":{ - "code":"DuplicateCertificate", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the same certificate is associated to another user under the account.
" - }, - { - "shape":"NoSuchEntityException", - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - } - ], - "documentation":" Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.
If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAMguide. The name of the IAM user that the access key is associated with.
" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"The ID for this access key.
" - }, - "Status":{ - "shape":"statusType", - "documentation":" The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
The secret key used to sign requests.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date when the access key was created.
" - } - }, - "documentation":"Contains information about an AWS access key.
This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.
SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key. The name of the IAM user that the key is associated with.
" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"The ID for this access key.
" - }, - "Status":{ - "shape":"statusType", - "documentation":"The status of the access key. Active means the key is valid for API calls; Inactive means it is not.
The date when the access key was created.
" - } - }, - "documentation":"Contains information about an AWS access key, without its secret key.
This data type is used as a response element in the ListAccessKeys action.
" - }, - "AddClientIDToOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ClientID" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
" - }, - "ClientID":{ - "shape":"clientIDType", - "documentation":"The client ID (also known as audience) to add to the IAM OpenID Connect provider.
" - } - } - }, - "AddRoleToInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "RoleName" - ], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"The name of the instance profile to update.
" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to add.
" - } - } - }, - "AddUserToGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "UserName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group to update.
" - }, - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to add.
" - } - } - }, - "BootstrapDatum":{ - "type":"blob", - "sensitive":true - }, - "ChangePasswordRequest":{ - "type":"structure", - "required":[ - "OldPassword", - "NewPassword" - ], - "members":{ - "OldPassword":{ - "shape":"passwordType", - "documentation":"The IAM user's current password.
" - }, - "NewPassword":{ - "shape":"passwordType", - "documentation":"The new password. The new password must conform to the AWS account's password policy, if one exists.
" - } - } - }, - "CreateAccessKeyRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The user name that the new key will belong to.
" - } - } - }, - "CreateAccessKeyResponse":{ - "type":"structure", - "required":["AccessKey"], - "members":{ - "AccessKey":{ - "shape":"AccessKey", - "documentation":"Information about the access key.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateAccessKey action.
" - }, - "CreateAccountAliasRequest":{ - "type":"structure", - "required":["AccountAlias"], - "members":{ - "AccountAlias":{ - "shape":"accountAliasType", - "documentation":"The name of the account alias to create.
" - } - } - }, - "CreateGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
" - }, - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group to create. Do not include the path in this value.
" - } - } - }, - "CreateGroupResponse":{ - "type":"structure", - "required":["Group"], - "members":{ - "Group":{ - "shape":"Group", - "documentation":"Information about the group.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateGroup action.
" - }, - "CreateInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"The name of the instance profile to create.
" - }, - "Path":{ - "shape":"pathType", - "documentation":"The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
" - } - } - }, - "CreateInstanceProfileResponse":{ - "type":"structure", - "required":["InstanceProfile"], - "members":{ - "InstanceProfile":{ - "shape":"InstanceProfile", - "documentation":"Information about the instance profile.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateInstanceProfileaction.
" - }, - "CreateLoginProfileRequest":{ - "type":"structure", - "required":[ - "UserName", - "Password" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user to create a password for.
" - }, - "Password":{ - "shape":"passwordType", - "documentation":"The new password for the user.
" - }, - "PasswordResetRequired":{ - "shape":"booleanType", - "documentation":"Specifies whether the user is required to set a new password on next sign-in.
" - } - } - }, - "CreateLoginProfileResponse":{ - "type":"structure", - "required":["LoginProfile"], - "members":{ - "LoginProfile":{ - "shape":"LoginProfile", - "documentation":"The user name and password create date.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateLoginProfile action.
" - }, - "CreateOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "Url", - "ThumbprintList" - ], - "members":{ - "Url":{ - "shape":"OpenIDConnectProviderUrlType", - "documentation":"The URL of the identity provider. The URL must begin with \"https://\" and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a host name, like \"https://server.example.org\" or \"https://example.com\".
You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
" - }, - "ClientIDList":{ - "shape":"clientIDListType", - "documentation":"A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest action accepts client IDs up to 255 characters long.
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is server.example.com and the provider stores its keys at \"https://keys.server.example.com/openid-connect\", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.
The Amazon Resource Name (ARN) of the IAM OpenID Connect provider that was created. For more information, see OpenIDConnectProviderListEntry.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateOpenIDConnectProvider action.
" - }, - "CreateRoleRequest":{ - "type":"structure", - "required":[ - "RoleName", - "AssumeRolePolicyDocument" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to create.
" - }, - "AssumeRolePolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy that grants an entity permission to assume the role.
" - } - } - }, - "CreateRoleResponse":{ - "type":"structure", - "required":["Role"], - "members":{ - "Role":{ - "shape":"Role", - "documentation":"Information about the role.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateRole action.
" - }, - "CreateSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLMetadataDocument", - "Name" - ], - "members":{ - "SAMLMetadataDocument":{ - "shape":"SAMLMetadataDocumentType", - "documentation":"An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary Security Credentials guide.
" - }, - "Name":{ - "shape":"SAMLProviderNameType", - "documentation":"The name of the provider to create.
" - } - } - }, - "CreateSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateSAMLProvider action.
" - }, - "CreateUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path for the user name. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user to create.
" - } - } - }, - "CreateUserResponse":{ - "type":"structure", - "members":{ - "User":{ - "shape":"User", - "documentation":"Information about the user.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateUser action.
" - }, - "CreateVirtualMFADeviceRequest":{ - "type":"structure", - "required":["VirtualMFADeviceName"], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
" - }, - "VirtualMFADeviceName":{ - "shape":"virtualMFADeviceName", - "documentation":"The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
" - } - } - }, - "CreateVirtualMFADeviceResponse":{ - "type":"structure", - "required":["VirtualMFADevice"], - "members":{ - "VirtualMFADevice":{ - "shape":"VirtualMFADevice", - "documentation":"A newly created virtual MFA device.
" - } - }, - "documentation":"Contains the result of a successful invocation of the CreateVirtualMFADevice action.
" - }, - "CredentialReportExpiredException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportExpiredExceptionMessage"} - }, - "error":{ - "code":"ReportExpired", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the Using IAM guide.
" - }, - "CredentialReportNotPresentException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportNotPresentExceptionMessage"} - }, - "error":{ - "code":"ReportNotPresent", - "httpStatusCode":410, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
" - }, - "CredentialReportNotReadyException":{ - "type":"structure", - "members":{ - "message":{"shape":"credentialReportNotReadyExceptionMessage"} - }, - "error":{ - "code":"ReportInProgress", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the credential report is still being generated.
" - }, - "DeactivateMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user whose MFA device you want to deactivate.
" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
" - } - } - }, - "DeleteAccessKeyRequest":{ - "type":"structure", - "required":["AccessKeyId"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user whose key you want to delete.
" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"The access key ID for the access key ID and secret access key you want to delete.
" - } - } - }, - "DeleteAccountAliasRequest":{ - "type":"structure", - "required":["AccountAlias"], - "members":{ - "AccountAlias":{ - "shape":"accountAliasType", - "documentation":"The name of the account alias to delete.
" - } - } - }, - "DeleteConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"deleteConflictMessage"} - }, - "error":{ - "code":"DeleteConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
" - }, - "DeleteGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document to delete.
" - } - } - }, - "DeleteGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group to delete.
" - } - } - }, - "DeleteInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"The name of the instance profile to delete.
" - } - } - }, - "DeleteLoginProfileRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user whose password you want to delete.
" - } - } - }, - "DeleteOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the IAM OpenID Connect provider to delete. You can get a list of OpenID Connect provider ARNs by using the ListOpenIDConnectProviders action.
" - } - } - }, - "DeleteRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role the associated with the policy.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document to delete.
" - } - } - }, - "DeleteRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to delete.
" - } - } - }, - "DeleteSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider to delete.
" - } - } - }, - "DeleteServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"The name of the server certificate you want to delete.
" - } - } - }, - "DeleteSigningCertificateRequest":{ - "type":"structure", - "required":["CertificateId"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user the signing certificate belongs to.
" - }, - "CertificateId":{ - "shape":"certificateIdType", - "documentation":"The ID of the signing certificate to delete.
" - } - } - }, - "DeleteUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document to delete.
" - } - } - }, - "DeleteUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to delete.
" - } - } - }, - "DeleteVirtualMFADeviceRequest":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.
" - } - } - }, - "DuplicateCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"duplicateCertificateMessage"} - }, - "error":{ - "code":"DuplicateCertificate", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the same certificate is associated to another user under the account.
" - }, - "EnableMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "AuthenticationCode1", - "AuthenticationCode2" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user for whom you want to enable the MFA device.
" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
" - }, - "AuthenticationCode1":{ - "shape":"authenticationCodeType", - "documentation":"An authentication code emitted by the device.
" - }, - "AuthenticationCode2":{ - "shape":"authenticationCodeType", - "documentation":"A subsequent authentication code emitted by the device.
" - } - } - }, - "EntityAlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{"shape":"entityAlreadyExistsMessage"} - }, - "error":{ - "code":"EntityAlreadyExists", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - "EntityTemporarilyUnmodifiableException":{ - "type":"structure", - "members":{ - "message":{"shape":"entityTemporarilyUnmodifiableMessage"} - }, - "error":{ - "code":"EntityTemporarilyUnmodifiable", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
" - }, - "EntityType":{ - "type":"string", - "enum":[ - "User", - "Role", - "Group" - ] - }, - "GenerateCredentialReportResponse":{ - "type":"structure", - "members":{ - "State":{ - "shape":"ReportStateType", - "documentation":"Information about the state of a credential report.
" - }, - "Description":{ - "shape":"ReportStateDescriptionType", - "documentation":"Information about the credential report.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GenerateCredentialReport action.
" - }, - "GetAccountAuthorizationDetailsRequest":{ - "type":"structure", - "members":{ - "Filter":{ - "shape":"entityListType", - "documentation":"A list of entity types (user, group, or role) for filtering the results.
" - }, - "MaxItems":{ - "shape":"maxItemsType", - "documentation":"Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
A list containing information about IAM users.
" - }, - "GroupDetailList":{ - "shape":"groupDetailListType", - "documentation":"A list containing information about IAM groups.
" - }, - "RoleDetailList":{ - "shape":"roleDetailListType", - "documentation":"A list containing information about IAM roles.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":"A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the GetAccountAuthorizationDetails action.
" - }, - "GetAccountPasswordPolicyResponse":{ - "type":"structure", - "required":["PasswordPolicy"], - "members":{ - "PasswordPolicy":{"shape":"PasswordPolicy"} - }, - "documentation":"Contains the result of a successful invocation of the GetAccountPasswordPolicy action.
" - }, - "GetAccountSummaryResponse":{ - "type":"structure", - "members":{ - "SummaryMap":{ - "shape":"summaryMapType", - "documentation":"A set of key value pairs containing account-level information.
SummaryMap contains the following keys:
AccessKeysPerUserQuota - Maximum number of access keys that can be created per user
AccountMFAEnabled - 1 if the root account has an MFA device assigned to it, 0 otherwise
AssumeRolePolicySizeQuota - Maximum allowed size for assume role policy documents (in kilobytes)
GroupPolicySizeQuota - Maximum allowed size for Group policy documents (in kilobytes)
Groups - Number of Groups for the AWS account
GroupsPerUserQuota - Maximum number of groups an IAM user can belong to
GroupsQuota - Maximum groups allowed for the AWS account
InstanceProfiles - Number of instance profiles for the AWS account
InstanceProfilesQuota - Maximum instance profiles allowed for the AWS account
MFADevices - Number of MFA devices, either assigned or unassigned
MFADevicesInUse - Number of MFA devices that have been assigned to an IAM user or to the root account
RolePolicySizeQuota - Maximum allowed size for role policy documents (in kilobytes)
Roles - Number of roles for the AWS account
RolesQuota - Maximum roles allowed for the AWS account
ServerCertificates - Number of server certificates for the AWS account
ServerCertificatesQuota - Maximum server certificates allowed for the AWS account
SigningCertificatesPerUserQuota - Maximum number of X509 certificates allowed for a user
UserPolicySizeQuota - Maximum allowed size for user policy documents (in kilobytes)
Users - Number of users for the AWS account
UsersQuota - Maximum users allowed for the AWS account
Contains the result of a successful invocation of the GetAccountSummary action.
" - }, - "GetCredentialReportResponse":{ - "type":"structure", - "members":{ - "Content":{ - "shape":"ReportContentType", - "documentation":"Contains the credential report. The report is Base64-encoded.
" - }, - "ReportFormat":{ - "shape":"ReportFormatType", - "documentation":"The format (MIME type) of the credential report.
" - }, - "GeneratedTime":{ - "shape":"dateType", - "documentation":"The date and time when the credential report was created, in ISO 8601 date-time format.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetCredentialReport action.
" - }, - "GetGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document to get.
" - } - } - }, - "GetGroupPolicyResponse":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The group the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetGroupPolicy action.
" - }, - "GetGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Information about the group.
" - }, - "Users":{ - "shape":"userListType", - "documentation":"A list of users in the group.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more user names in the list.
If IsTruncated is true, then this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the GetGroup action.
" - }, - "GetInstanceProfileRequest":{ - "type":"structure", - "required":["InstanceProfileName"], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"The name of the instance profile to get information about.
" - } - } - }, - "GetInstanceProfileResponse":{ - "type":"structure", - "required":["InstanceProfile"], - "members":{ - "InstanceProfile":{ - "shape":"InstanceProfile", - "documentation":"Information about the instance profile.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetInstanceProfile action.
" - }, - "GetLoginProfileRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user whose login profile you want to retrieve.
" - } - } - }, - "GetLoginProfileResponse":{ - "type":"structure", - "required":["LoginProfile"], - "members":{ - "LoginProfile":{ - "shape":"LoginProfile", - "documentation":"The user name and password create date for the user.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetLoginProfile action.
" - }, - "GetOpenIDConnectProviderRequest":{ - "type":"structure", - "required":["OpenIDConnectProviderArn"], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to get information for. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
" - } - } - }, - "GetOpenIDConnectProviderResponse":{ - "type":"structure", - "members":{ - "Url":{ - "shape":"OpenIDConnectProviderUrlType", - "documentation":"The URL that the IAM OpenID Connect provider is associated with. For more information, see CreateOpenIDConnectProvider.
" - }, - "ClientIDList":{ - "shape":"clientIDListType", - "documentation":"A list of client IDs (also known as audiences) that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
" - }, - "ThumbprintList":{ - "shape":"thumbprintListType", - "documentation":"A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time when the IAM OpenID Connect provider entity was created in the AWS account.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetOpenIDConnectProvider action.
" - }, - "GetRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role associated with the policy.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document to get.
" - } - } - }, - "GetRolePolicyResponse":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The role the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetRolePolicy action.
" - }, - "GetRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to get information about.
" - } - } - }, - "GetRoleResponse":{ - "type":"structure", - "required":["Role"], - "members":{ - "Role":{ - "shape":"Role", - "documentation":"Information about the role.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetRole action.
" - }, - "GetSAMLProviderRequest":{ - "type":"structure", - "required":["SAMLProviderArn"], - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider to get information about.
" - } - } - }, - "GetSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLMetadataDocument":{ - "shape":"SAMLMetadataDocumentType", - "documentation":"The XML metadata document that includes information about an identity provider.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time when the SAML provider was created.
" - }, - "ValidUntil":{ - "shape":"dateType", - "documentation":"The expiration date and time for the SAML provider.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetSAMLProvider action.
" - }, - "GetServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"The name of the server certificate you want to retrieve information about.
" - } - } - }, - "GetServerCertificateResponse":{ - "type":"structure", - "required":["ServerCertificate"], - "members":{ - "ServerCertificate":{ - "shape":"ServerCertificate", - "documentation":"Information about the server certificate.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetServerCertificate action.
" - }, - "GetUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user who the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document to get.
" - } - } - }, - "GetUserPolicyResponse":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The user the policy is associated with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetUserPolicy action.
" - }, - "GetUserRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to get information about.
This parameter is optional. If it is not included, it defaults to the user making the request.
" - } - } - }, - "GetUserResponse":{ - "type":"structure", - "required":["User"], - "members":{ - "User":{ - "shape":"User", - "documentation":"Information about the user.
" - } - }, - "documentation":"Contains the result of a successful invocation of the GetUser action.
" - }, - "Group":{ - "type":"structure", - "required":[ - "Path", - "GroupName", - "GroupId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "GroupName":{ - "shape":"groupNameType", - "documentation":"The friendly name that identifies the group.
" - }, - "GroupId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the group was created.
" - } - }, - "documentation":"Contains information about an IAM group entity.
This data type is used as a response element in the following actions:
" - }, - "GroupDetail":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "GroupName":{ - "shape":"groupNameType", - "documentation":"The friendly name that identifies the group.
" - }, - "GroupId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{"shape":"arnType"}, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the group was created.
" - }, - "GroupPolicyList":{ - "shape":"policyDetailListType", - "documentation":"A list of the policies attached to the group.
" - } - }, - "documentation":"Contains information about an IAM group, including all of the policies attached to the group.
The data type is used as a response element in the GetAccountAuthorizationDetails action.
" - }, - "InstanceProfile":{ - "type":"structure", - "required":[ - "Path", - "InstanceProfileName", - "InstanceProfileId", - "Arn", - "CreateDate", - "Roles" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"The name identifying the instance profile.
" - }, - "InstanceProfileId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date when the instance profile was created.
" - }, - "Roles":{ - "shape":"roleListType", - "documentation":"The role associated with the instance profile.
" - } - }, - "documentation":"Contains information about an instance profile.
This data type is used as a response element in the following actions:
" - }, - "InvalidAuthenticationCodeException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidAuthenticationCodeMessage"} - }, - "error":{ - "code":"InvalidAuthenticationCode", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the authentication code was not recognized. The error message describes the specific error.
" - }, - "InvalidCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidCertificateMessage"} - }, - "error":{ - "code":"InvalidCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the certificate is invalid.
" - }, - "InvalidInputException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidInputMessage"} - }, - "error":{ - "code":"InvalidInput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
" - }, - "InvalidUserTypeException":{ - "type":"structure", - "members":{ - "message":{"shape":"invalidUserTypeMessage"} - }, - "error":{ - "code":"InvalidUserType", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the type of user for the transaction was incorrect.
" - }, - "KeyPairMismatchException":{ - "type":"structure", - "members":{ - "message":{"shape":"keyPairMismatchMessage"} - }, - "error":{ - "code":"KeyPairMismatch", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the public key certificate and the private key do not match.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"limitExceededMessage"} - }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
" - }, - "ListAccessKeysRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of keys you want in the response. If there are additional keys beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of access key metadata.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more keys to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more keys in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListAccessKeys action.
" - }, - "ListAccountAliasesRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of account aliases you want in the response. If there are additional account aliases beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of aliases associated with the account.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more account aliases to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more account aliases in the list.
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Contains the result of a successful invocation of the ListAccountAliases action.
" - }, - "ListGroupPoliciesRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group to list policies for.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of policy names.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListGroupPolicies action.
" - }, - "ListGroupsForUserRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to list groups for.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of groups.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListGroupsForUser action.
" - }, - "ListGroupsRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":" The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of groups you want in the response. If there are additional groups beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of groups.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more groups to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more groups in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListGroups action.
" - }, - "ListInstanceProfilesForRoleRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to list instance profiles for.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of instance profiles you want in the response. If there are additional instance profiles beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of instance profiles.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListInstanceProfilesForRole action.
" - }, - "ListInstanceProfilesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":" The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of instance profiles you want in the response. If there are additional instance profiles beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of instance profiles.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more instance profiles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more instance profiles in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListInstanceProfiles action.
" - }, - "ListMFADevicesRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user whose MFA devices you want to list.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of MFA devices.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more MFA devices to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more MFA devices in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListMFADevices action.
" - }, - "ListOpenIDConnectProvidersRequest":{ - "type":"structure", - "members":{ - } - }, - "ListOpenIDConnectProvidersResponse":{ - "type":"structure", - "members":{ - "OpenIDConnectProviderList":{ - "shape":"OpenIDConnectProviderListType", - "documentation":"The list of IAM OpenID Connect providers in the AWS account.
" - } - }, - "documentation":"Contains the result of a successful invocation of the ListOpenIDConnectProviders action.
" - }, - "ListRolePoliciesRequest":{ - "type":"structure", - "required":["RoleName"], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to list policies for.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of role policies you want in the response. If there are additional role policies beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of policy names.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListRolePolicies action.
" - }, - "ListRolesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":" The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of roles you want in the response. If there are additional roles beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of roles.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more roles to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more roles in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListRoles action.
" - }, - "ListSAMLProvidersRequest":{ - "type":"structure", - "members":{ - } - }, - "ListSAMLProvidersResponse":{ - "type":"structure", - "members":{ - "SAMLProviderList":{ - "shape":"SAMLProviderListType", - "documentation":"The list of SAML providers for this account.
" - } - }, - "documentation":"Contains the result of a successful invocation of the ListSAMLProviders action.
" - }, - "ListServerCertificatesRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":" The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of server certificates you want in the response. If there are additional server certificates beyond the maximum you specify, the IsTruncated response element will be set to true. This parameter is optional. If you do not include it, it defaults to 100.
A list of server certificates.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more server certificates to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more server certificates in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListServerCertificates action.
" - }, - "ListSigningCertificatesRequest":{ - "type":"structure", - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of certificate IDs you want in the response. If there are additional certificate IDs beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of the user's signing certificate information.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more certificate IDs to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more certificates in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListSigningCertificates action.
" - }, - "ListUserPoliciesRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to list policies for.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this only when paginating results to indicate the maximum number of policy names you want in the response. If there are additional policy names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of policy names.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more policy names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policy names in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListUserPolicies action.
" - }, - "ListUsersRequest":{ - "type":"structure", - "members":{ - "PathPrefix":{ - "shape":"pathPrefixType", - "documentation":" The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.
" - }, - "Marker":{ - "shape":"markerType", - "documentation":" Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
A list of users.
" - }, - "IsTruncated":{ - "shape":"booleanType", - "documentation":" A flag that indicates whether there are more user names to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more users in the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListUsers action.
" - }, - "ListVirtualMFADevicesRequest":{ - "type":"structure", - "members":{ - "AssignmentStatus":{ - "shape":"assignmentStatusType", - "documentation":" The status (unassigned or assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Use this parameter only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.
A flag that indicates whether there are more items to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items the list.
If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Contains the result of a successful invocation of the ListVirtualMFADevicesaction.
" - }, - "LoginProfile":{ - "type":"structure", - "required":[ - "UserName", - "CreateDate" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user, which can be used for signing in to the AWS Management Console.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date when the password for the user was created.
" - }, - "PasswordResetRequired":{ - "shape":"booleanType", - "documentation":"Specifies whether the user is required to set a new password on next sign-in.
" - } - }, - "documentation":"Contains the user name and password create date for a user.
This data type is used as a response element in the CreateLoginProfile and GetLoginProfile actions.
" - }, - "MFADevice":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "EnableDate" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The user with whom the MFA device is associated.
" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
" - }, - "EnableDate":{ - "shape":"dateType", - "documentation":"The date when the MFA device was enabled for the user.
" - } - }, - "documentation":"Contains information about an MFA device.
This data type is used as a response element in the ListMFADevices action.
" - }, - "MalformedCertificateException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedCertificateMessage"} - }, - "error":{ - "code":"MalformedCertificate", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
" - }, - "MalformedPolicyDocumentException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedPolicyDocumentMessage"} - }, - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - "NoSuchEntityException":{ - "type":"structure", - "members":{ - "message":{"shape":"noSuchEntityMessage"} - }, - "error":{ - "code":"NoSuchEntity", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
" - }, - "OpenIDConnectProviderListEntry":{ - "type":"structure", - "members":{ - "Arn":{"shape":"arnType"} - }, - "documentation":"Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.
" - }, - "OpenIDConnectProviderListType":{ - "type":"list", - "member":{"shape":"OpenIDConnectProviderListEntry"}, - "documentation":"Contains a list of IAM OpenID Connect providers.
" - }, - "OpenIDConnectProviderUrlType":{ - "type":"string", - "min":1, - "max":255, - "documentation":"Contains a URL that specifies the endpoint for an OpenID Connect provider.
" - }, - "PasswordPolicy":{ - "type":"structure", - "members":{ - "MinimumPasswordLength":{ - "shape":"minimumPasswordLengthType", - "documentation":"Minimum length to require for IAM user passwords.
" - }, - "RequireSymbols":{ - "shape":"booleanType", - "documentation":"Specifies whether to require symbols for IAM user passwords.
" - }, - "RequireNumbers":{ - "shape":"booleanType", - "documentation":"Specifies whether to require numbers for IAM user passwords.
" - }, - "RequireUppercaseCharacters":{ - "shape":"booleanType", - "documentation":"Specifies whether to require uppercase characters for IAM user passwords.
" - }, - "RequireLowercaseCharacters":{ - "shape":"booleanType", - "documentation":"Specifies whether to require lowercase characters for IAM user passwords.
" - }, - "AllowUsersToChangePassword":{ - "shape":"booleanType", - "documentation":"Specifies whether IAM users are allowed to change their own password.
" - }, - "ExpirePasswords":{ - "shape":"booleanType", - "documentation":"Specifies whether IAM users are required to change their password after a specified number of days.
" - }, - "MaxPasswordAge":{ - "shape":"maxPasswordAgeType", - "documentation":"The number of days that an IAM user password is valid.
" - }, - "PasswordReusePrevention":{ - "shape":"passwordReusePreventionType", - "documentation":"Specifies the number of previous passwords that IAM users are prevented from reusing.
" - }, - "HardExpiry":{ - "shape":"booleanObjectType", - "documentation":"Specifies whether IAM users are prevented from setting a new password after their password has expired.
" - } - }, - "documentation":"Contains information about the account password policy.
This data type is used as a response element in the GetAccountPasswordPolicy action.
" - }, - "PasswordPolicyViolationException":{ - "type":"structure", - "members":{ - "message":{"shape":"passwordPolicyViolationMessage"} - }, - "error":{ - "code":"PasswordPolicyViolation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
" - }, - "PolicyDetail":{ - "type":"structure", - "members":{ - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
The returned policy is URL-encoded according to RFC 3986.
" - } - }, - "documentation":"Contains information about an IAM policy, including the policy document.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
" - }, - "PutGroupPolicyRequest":{ - "type":"structure", - "required":[ - "GroupName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group to associate the policy with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
" - } - } - }, - "PutRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to associate the policy with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
" - } - } - }, - "PutUserPolicyRequest":{ - "type":"structure", - "required":[ - "UserName", - "PolicyName", - "PolicyDocument" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to associate the policy with.
" - }, - "PolicyName":{ - "shape":"policyNameType", - "documentation":"The name of the policy document.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy document.
" - } - } - }, - "RemoveClientIDFromOpenIDConnectProviderRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ClientID" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
" - }, - "ClientID":{ - "shape":"clientIDType", - "documentation":"The client ID (also known as audience) to remove from the IAM OpenID Connect provider. For more information about client IDs, see CreateOpenIDConnectProvider.
" - } - } - }, - "RemoveRoleFromInstanceProfileRequest":{ - "type":"structure", - "required":[ - "InstanceProfileName", - "RoleName" - ], - "members":{ - "InstanceProfileName":{ - "shape":"instanceProfileNameType", - "documentation":"The name of the instance profile to update.
" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to remove.
" - } - } - }, - "RemoveUserFromGroupRequest":{ - "type":"structure", - "required":[ - "GroupName", - "UserName" - ], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"The name of the group to update.
" - }, - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user to remove.
" - } - } - }, - "ReportContentType":{"type":"blob"}, - "ReportFormatType":{ - "type":"string", - "enum":["text/csv"] - }, - "ReportStateDescriptionType":{"type":"string"}, - "ReportStateType":{ - "type":"string", - "enum":[ - "STARTED", - "INPROGRESS", - "COMPLETE" - ] - }, - "ResyncMFADeviceRequest":{ - "type":"structure", - "required":[ - "UserName", - "SerialNumber", - "AuthenticationCode1", - "AuthenticationCode2" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user whose MFA device you want to resynchronize.
" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"Serial number that uniquely identifies the MFA device.
" - }, - "AuthenticationCode1":{ - "shape":"authenticationCodeType", - "documentation":"An authentication code emitted by the device.
" - }, - "AuthenticationCode2":{ - "shape":"authenticationCodeType", - "documentation":"A subsequent authentication code emitted by the device.
" - } - } - }, - "Role":{ - "type":"structure", - "required":[ - "Path", - "RoleName", - "RoleId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"The friendly name that identifies the role.
" - }, - "RoleId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the role was created.
" - }, - "AssumeRolePolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy that grants an entity permission to assume the role.
The returned policy is URL-encoded according to RFC 3986.
" - } - }, - "documentation":"Contains information about an IAM role.
This data type is used as a response element in the following actions:
" - }, - "RoleDetail":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "RoleName":{ - "shape":"roleNameType", - "documentation":"The friendly name that identifies the role.
" - }, - "RoleId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{"shape":"arnType"}, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the role was created.
" - }, - "AssumeRolePolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The trust policy that grants an entity permission to assume the role.
The returned policy is URL-encoded according to RFC 3986.
" - }, - "InstanceProfileList":{"shape":"instanceProfileListType"}, - "RolePolicyList":{ - "shape":"policyDetailListType", - "documentation":"A list of the access (permissions) policies attached to the role.
" - } - }, - "documentation":"Contains information about an IAM role, including all of the access policies attached to the role.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
" - }, - "SAMLMetadataDocumentType":{ - "type":"string", - "min":1000, - "max":10000000 - }, - "SAMLProviderListEntry":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider.
" - }, - "ValidUntil":{ - "shape":"dateType", - "documentation":"The expiration date and time for the SAML provider.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time when the SAML provider was created.
" - } - }, - "documentation":"Contains the list of SAML providers for this account.
" - }, - "SAMLProviderListType":{ - "type":"list", - "member":{"shape":"SAMLProviderListEntry"} - }, - "SAMLProviderNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w._-]*" - }, - "ServerCertificate":{ - "type":"structure", - "required":[ - "ServerCertificateMetadata", - "CertificateBody" - ], - "members":{ - "ServerCertificateMetadata":{ - "shape":"ServerCertificateMetadata", - "documentation":"The meta information of the server certificate, such as its name, path, ID, and ARN.
" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"The contents of the public key certificate.
" - }, - "CertificateChain":{ - "shape":"certificateChainType", - "documentation":"The contents of the public key certificate chain.
" - } - }, - "documentation":"Contains information about a server certificate.
This data type is used as a response element in the GetServerCertificate action.
" - }, - "ServerCertificateMetadata":{ - "type":"structure", - "required":[ - "Path", - "ServerCertificateName", - "ServerCertificateId", - "Arn" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"The name that identifies the server certificate.
" - }, - "ServerCertificateId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
" - }, - "UploadDate":{ - "shape":"dateType", - "documentation":"The date when the server certificate was uploaded.
" - }, - "Expiration":{ - "shape":"dateType", - "documentation":"The date on which the certificate is set to expire.
" - } - }, - "documentation":"Contains information about a server certificate without its certificate body, certificate chain, and private key.
This data type is used as a response element in the UploadServerCertificate and ListServerCertificates actions.
" - }, - "SigningCertificate":{ - "type":"structure", - "required":[ - "UserName", - "CertificateId", - "CertificateBody", - "Status" - ], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user the signing certificate is associated with.
" - }, - "CertificateId":{ - "shape":"certificateIdType", - "documentation":"The ID for the signing certificate.
" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"The contents of the signing certificate.
" - }, - "Status":{ - "shape":"statusType", - "documentation":"The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.
The date when the signing certificate was uploaded.
" - } - }, - "documentation":"Contains information about an X.509 signing certificate.
This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.
" - }, - "UpdateAccessKeyRequest":{ - "type":"structure", - "required":[ - "AccessKeyId", - "Status" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user whose key you want to update.
" - }, - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"The access key ID of the secret access key you want to update.
" - }, - "Status":{ - "shape":"statusType", - "documentation":" The status you want to assign to the secret access key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.
The minimum number of characters allowed in an IAM user password.
Default value: 6
" - }, - "RequireSymbols":{ - "shape":"booleanType", - "documentation":"Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
Default value: false
" - }, - "RequireNumbers":{ - "shape":"booleanType", - "documentation":"Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
Default value: false
" - }, - "RequireUppercaseCharacters":{ - "shape":"booleanType", - "documentation":"Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
Default value: false
" - }, - "RequireLowercaseCharacters":{ - "shape":"booleanType", - "documentation":"Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
Default value: false
" - }, - "AllowUsersToChangePassword":{ - "shape":"booleanType", - "documentation":"Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the Using IAM guide.
Default value: false
" - }, - "MaxPasswordAge":{ - "shape":"maxPasswordAgeType", - "documentation":"The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.
Default value: 0
" - }, - "PasswordReusePrevention":{ - "shape":"passwordReusePreventionType", - "documentation":"Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.
Default value: 0
" - }, - "HardExpiry":{ - "shape":"booleanObjectType", - "documentation":"Prevents IAM users from setting a new password after their password has expired.
Default value: false
" - } - } - }, - "UpdateAssumeRolePolicyRequest":{ - "type":"structure", - "required":[ - "RoleName", - "PolicyDocument" - ], - "members":{ - "RoleName":{ - "shape":"roleNameType", - "documentation":"The name of the role to update.
" - }, - "PolicyDocument":{ - "shape":"policyDocumentType", - "documentation":"The policy that grants an entity permission to assume the role.
" - } - } - }, - "UpdateGroupRequest":{ - "type":"structure", - "required":["GroupName"], - "members":{ - "GroupName":{ - "shape":"groupNameType", - "documentation":"Name of the group to update. If you're changing the name of the group, this is the original name.
" - }, - "NewPath":{ - "shape":"pathType", - "documentation":"New path for the group. Only include this if changing the group's path.
" - }, - "NewGroupName":{ - "shape":"groupNameType", - "documentation":"New name for the group. Only include this if changing the group's name.
" - } - } - }, - "UpdateLoginProfileRequest":{ - "type":"structure", - "required":["UserName"], - "members":{ - "UserName":{ - "shape":"userNameType", - "documentation":"The name of the user whose password you want to update.
" - }, - "Password":{ - "shape":"passwordType", - "documentation":"The new password for the specified user.
" - }, - "PasswordResetRequired":{ - "shape":"booleanObjectType", - "documentation":"Require the specified user to set a new password on next sign-in.
" - } - } - }, - "UpdateOpenIDConnectProviderThumbprintRequest":{ - "type":"structure", - "required":[ - "OpenIDConnectProviderArn", - "ThumbprintList" - ], - "members":{ - "OpenIDConnectProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to update the thumbprint for. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
" - }, - "ThumbprintList":{ - "shape":"thumbprintListType", - "documentation":"A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
" - } - } - }, - "UpdateSAMLProviderRequest":{ - "type":"structure", - "required":[ - "SAMLMetadataDocument", - "SAMLProviderArn" - ], - "members":{ - "SAMLMetadataDocument":{ - "shape":"SAMLMetadataDocumentType", - "documentation":"An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
" - }, - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider to update.
" - } - } - }, - "UpdateSAMLProviderResponse":{ - "type":"structure", - "members":{ - "SAMLProviderArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider that was updated.
" - } - }, - "documentation":"Contains the result of a successful invocation of the UpdateSAMLProvider action.
" - }, - "UpdateServerCertificateRequest":{ - "type":"structure", - "required":["ServerCertificateName"], - "members":{ - "ServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"The name of the server certificate that you want to update.
" - }, - "NewPath":{ - "shape":"pathType", - "documentation":"The new path for the server certificate. Include this only if you are updating the server certificate's path.
" - }, - "NewServerCertificateName":{ - "shape":"serverCertificateNameType", - "documentation":"The new name for the server certificate. Include this only if you are updating the server certificate's name.
" - } - } - }, - "UpdateSigningCertificateRequest":{ - "type":"structure", - "required":[ - "CertificateId", - "Status" - ], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user the signing certificate belongs to.
" - }, - "CertificateId":{ - "shape":"certificateIdType", - "documentation":"The ID of the signing certificate you want to update.
" - }, - "Status":{ - "shape":"statusType", - "documentation":" The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.
Name of the user to update. If you're changing the name of the user, this is the original user name.
" - }, - "NewPath":{ - "shape":"pathType", - "documentation":"New path for the user. Include this parameter only if you're changing the user's path.
" - }, - "NewUserName":{ - "shape":"userNameType", - "documentation":"New name for the user. Include this parameter only if you're changing the user's name.
" - } - } - }, - "UploadServerCertificateRequest":{ - "type":"structure", - "required":[ - "ServerCertificateName", - "CertificateBody", - "PrivateKey" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path for the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
--path option. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/). The name for the server certificate. Do not include the path in this value.
" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"The contents of the public key certificate in PEM-encoded format.
" - }, - "PrivateKey":{ - "shape":"privateKeyType", - "documentation":"The contents of the private key in PEM-encoded format.
" - }, - "CertificateChain":{ - "shape":"certificateChainType", - "documentation":"The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
" - } - } - }, - "UploadServerCertificateResponse":{ - "type":"structure", - "members":{ - "ServerCertificateMetadata":{ - "shape":"ServerCertificateMetadata", - "documentation":"The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
" - } - }, - "documentation":"Contains the result of a successful invocation of the UploadServerCertificate action.
" - }, - "UploadSigningCertificateRequest":{ - "type":"structure", - "required":["CertificateBody"], - "members":{ - "UserName":{ - "shape":"existingUserNameType", - "documentation":"The name of the user the signing certificate is for.
" - }, - "CertificateBody":{ - "shape":"certificateBodyType", - "documentation":"The contents of the signing certificate.
" - } - } - }, - "UploadSigningCertificateResponse":{ - "type":"structure", - "required":["Certificate"], - "members":{ - "Certificate":{ - "shape":"SigningCertificate", - "documentation":"Information about the certificate.
" - } - }, - "documentation":"Contains the result of a successful invocation of the UploadSigningCertificate action.
" - }, - "User":{ - "type":"structure", - "required":[ - "Path", - "UserName", - "UserId", - "Arn", - "CreateDate" - ], - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"The friendly name identifying the user.
" - }, - "UserId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.
" - }, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the user was created.
" - }, - "PasswordLastUsed":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. When the user does not have a password, this field is null (not present). When a user's password exists but has never been used, or when there is no sign-in data associated with the user, this field is null (not present).
This value is returned only in the GetUser and ListUsers actions.
" - } - }, - "documentation":"Contains information about an IAM user entity.
This data type is used as a response element in the following actions:
" - }, - "UserDetail":{ - "type":"structure", - "members":{ - "Path":{ - "shape":"pathType", - "documentation":"The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
" - }, - "UserName":{ - "shape":"userNameType", - "documentation":"The friendly name identifying the user.
" - }, - "UserId":{ - "shape":"idType", - "documentation":"The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" - }, - "Arn":{"shape":"arnType"}, - "CreateDate":{ - "shape":"dateType", - "documentation":"The date and time, in ISO 8601 date-time format, when the user was created.
" - }, - "UserPolicyList":{ - "shape":"policyDetailListType", - "documentation":"A list of the policies attached to the user.
" - }, - "GroupList":{ - "shape":"groupNameListType", - "documentation":"A list of the IAM groups that the user is in.
" - } - }, - "documentation":"Contains information about an IAM user, including all the policies attached to the user and all the IAM groups the user is in.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
" - }, - "VirtualMFADevice":{ - "type":"structure", - "required":["SerialNumber"], - "members":{ - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The serial number associated with VirtualMFADevice.
The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments, AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in Base32 format. The Base32String value is Base64-encoded.
The date and time on which the virtual MFA device was enabled.
" - } - }, - "documentation":"Contains information about a virtual MFA device.
" - }, - "accessKeyIdType":{ - "type":"string", - "min":16, - "max":32, - "pattern":"[\\w]*" - }, - "accessKeyMetadataListType":{ - "type":"list", - "member":{"shape":"AccessKeyMetadata"}, - "documentation":"Contains a list of access key metadata.
This data type is used as a response element in the ListAccessKeys action.
" - }, - "accessKeySecretType":{ - "type":"string", - "sensitive":true - }, - "accountAliasListType":{ - "type":"list", - "member":{"shape":"accountAliasType"} - }, - "accountAliasType":{ - "type":"string", - "min":3, - "max":63, - "pattern":"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$" - }, - "arnType":{ - "type":"string", - "min":20, - "max":2048, - "documentation":"The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
" - }, - "assignmentStatusType":{ - "type":"string", - "enum":[ - "Assigned", - "Unassigned", - "Any" - ] - }, - "authenticationCodeType":{ - "type":"string", - "min":6, - "max":6, - "pattern":"[\\d]*" - }, - "booleanObjectType":{ - "type":"boolean", - "box":true - }, - "booleanType":{"type":"boolean"}, - "certificateBodyType":{ - "type":"string", - "min":1, - "max":16384, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "certificateChainType":{ - "type":"string", - "min":1, - "max":2097152, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*" - }, - "certificateIdType":{ - "type":"string", - "min":24, - "max":128, - "pattern":"[\\w]*" - }, - "certificateListType":{ - "type":"list", - "member":{"shape":"SigningCertificate"}, - "documentation":"Contains a list of signing certificates.
This data type is used as a response element in the ListSigningCertificates action.
" - }, - "clientIDListType":{ - "type":"list", - "member":{"shape":"clientIDType"} - }, - "clientIDType":{ - "type":"string", - "min":1, - "max":255 - }, - "credentialReportExpiredExceptionMessage":{"type":"string"}, - "credentialReportNotPresentExceptionMessage":{"type":"string"}, - "credentialReportNotReadyExceptionMessage":{"type":"string"}, - "dateType":{"type":"timestamp"}, - "deleteConflictMessage":{"type":"string"}, - "duplicateCertificateMessage":{"type":"string"}, - "entityAlreadyExistsMessage":{"type":"string"}, - "entityListType":{ - "type":"list", - "member":{"shape":"EntityType"} - }, - "entityTemporarilyUnmodifiableMessage":{"type":"string"}, - "existingUserNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w+=,.@-]*" - }, - "groupDetailListType":{ - "type":"list", - "member":{"shape":"GroupDetail"} - }, - "groupListType":{ - "type":"list", - "member":{"shape":"Group"}, - "documentation":"Contains a list of IAM groups.
This data type is used as a response element in the ListGroups action.
" - }, - "groupNameListType":{ - "type":"list", - "member":{"shape":"groupNameType"} - }, - "groupNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w+=,.@-]*" - }, - "idType":{ - "type":"string", - "min":16, - "max":32, - "pattern":"[\\w]*" - }, - "instanceProfileListType":{ - "type":"list", - "member":{"shape":"InstanceProfile"}, - "documentation":"Contains a list of instance profiles.
" - }, - "instanceProfileNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w+=,.@-]*" - }, - "invalidAuthenticationCodeMessage":{"type":"string"}, - "invalidCertificateMessage":{"type":"string"}, - "invalidInputMessage":{"type":"string"}, - "invalidUserTypeMessage":{"type":"string"}, - "keyPairMismatchMessage":{"type":"string"}, - "limitExceededMessage":{"type":"string"}, - "malformedCertificateMessage":{"type":"string"}, - "malformedPolicyDocumentMessage":{"type":"string"}, - "markerType":{ - "type":"string", - "min":1, - "max":320, - "pattern":"[\\u0020-\\u00FF]*" - }, - "maxItemsType":{ - "type":"integer", - "min":1, - "max":1000 - }, - "maxPasswordAgeType":{ - "type":"integer", - "min":1, - "max":1095, - "box":true - }, - "mfaDeviceListType":{ - "type":"list", - "member":{"shape":"MFADevice"}, - "documentation":"Contains a list of MFA devices.
This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices actions.
" - }, - "minimumPasswordLengthType":{ - "type":"integer", - "min":6, - "max":128 - }, - "noSuchEntityMessage":{"type":"string"}, - "passwordPolicyViolationMessage":{"type":"string"}, - "passwordReusePreventionType":{ - "type":"integer", - "min":1, - "max":24, - "box":true - }, - "passwordType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", - "sensitive":true - }, - "pathPrefixType":{ - "type":"string", - "min":1, - "max":512, - "pattern":"\\u002F[\\u0021-\\u007F]*" - }, - "pathType":{ - "type":"string", - "min":1, - "max":512, - "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)" - }, - "policyDetailListType":{ - "type":"list", - "member":{"shape":"PolicyDetail"} - }, - "policyDocumentType":{ - "type":"string", - "min":1, - "max":131072, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "policyNameListType":{ - "type":"list", - "member":{"shape":"policyNameType"}, - "documentation":"Contains a list of policy names.
This data type is used as a response element in the ListPolicies action.
" - }, - "policyNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w+=,.@-]*" - }, - "privateKeyType":{ - "type":"string", - "min":1, - "max":16384, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*", - "sensitive":true - }, - "roleDetailListType":{ - "type":"list", - "member":{"shape":"RoleDetail"} - }, - "roleListType":{ - "type":"list", - "member":{"shape":"Role"}, - "documentation":"Contains a list of IAM roles.
This data type is used as a response element in the ListRoles action.
" - }, - "roleNameType":{ - "type":"string", - "min":1, - "max":64, - "pattern":"[\\w+=,.@-]*" - }, - "serialNumberType":{ - "type":"string", - "min":9, - "max":256, - "pattern":"[\\w+=/:,.@-]*" - }, - "serverCertificateMetadataListType":{ - "type":"list", - "member":{"shape":"ServerCertificateMetadata"} - }, - "serverCertificateNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w+=,.@-]*" - }, - "statusType":{ - "type":"string", - "enum":[ - "Active", - "Inactive" - ] - }, - "summaryKeyType":{ - "type":"string", - "enum":[ - "Users", - "UsersQuota", - "Groups", - "GroupsQuota", - "ServerCertificates", - "ServerCertificatesQuota", - "UserPolicySizeQuota", - "GroupPolicySizeQuota", - "GroupsPerUserQuota", - "SigningCertificatesPerUserQuota", - "AccessKeysPerUserQuota", - "MFADevices", - "MFADevicesInUse", - "AccountMFAEnabled" - ] - }, - "summaryMapType":{ - "type":"map", - "key":{"shape":"summaryKeyType"}, - "value":{"shape":"summaryValueType"} - }, - "summaryValueType":{"type":"integer"}, - "thumbprintListType":{ - "type":"list", - "member":{"shape":"thumbprintType"}, - "documentation":"Contains a list of thumbprints of identity provider server certificates.
" - }, - "thumbprintType":{ - "type":"string", - "min":40, - "max":40, - "documentation":"Contains a thumbprint for an identity provider's server certificate.
The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
" - }, - "userDetailListType":{ - "type":"list", - "member":{"shape":"UserDetail"} - }, - "userListType":{ - "type":"list", - "member":{"shape":"User"}, - "documentation":"Contains a list of users.
This data type is used as a response element in the GetGroup and ListUsers actions.
" - }, - "userNameType":{ - "type":"string", - "min":1, - "max":64, - "pattern":"[\\w+=,.@-]*" - }, - "virtualMFADeviceListType":{ - "type":"list", - "member":{"shape":"VirtualMFADevice"} - }, - "virtualMFADeviceName":{ - "type":"string", - "min":1, - "pattern":"[\\w+=,.@-]*" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/iam/2010-05-08.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/iam/2010-05-08.paginators.json deleted file mode 100644 index b738bbd9e8..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/iam/2010-05-08.paginators.json +++ /dev/null @@ -1,119 +0,0 @@ -{ - "pagination": { - "GetGroup": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "Users", - "non_aggregate_keys": [ - "Group" - ] - }, - "ListAccessKeys": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "AccessKeyMetadata" - }, - "ListAccountAliases": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "AccountAliases" - }, - "ListGroupPolicies": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "PolicyNames" - }, - "ListGroups": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "Groups" - }, - "ListGroupsForUser": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "Groups" - }, - "ListInstanceProfiles": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "InstanceProfiles" - }, - "ListInstanceProfilesForRole": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "InstanceProfiles" - }, - "ListMFADevices": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "MFADevices" - }, - "ListRolePolicies": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "PolicyNames" - }, - "ListRoles": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "Roles" - }, - "ListServerCertificates": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "ServerCertificateMetadataList" - }, - "ListSigningCertificates": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "Certificates" - }, - "ListUserPolicies": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "PolicyNames" - }, - "ListUsers": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "Users" - }, - "ListVirtualMFADevices": { - "input_token": "Marker", - "output_token": "Marker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "VirtualMFADevices" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/importexport/2010-06-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/importexport/2010-06-01.normal.json deleted file mode 100644 index ebbca45136..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/importexport/2010-06-01.normal.json +++ /dev/null @@ -1,687 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-06-01", - "endpointPrefix":"importexport", - "globalEndpoint":"importexport.amazonaws.com", - "serviceFullName":"AWS Import/Export", - "signatureVersion":"v2", - "xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/", - "protocol":"query" - }, - "documentation":"Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.
", - "operations":{ - "AddTagsToStream":{ - "name":"AddTagsToStream", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddTagsToStreamInput", - "documentation":"Represents the input for AddTagsToStream.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.
If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.
Represents the input for CreateStream.
The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - }, - { - "shape":"InvalidArgumentException", - "exception":true, - "documentation":"A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - } - ], - "documentation":"Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.
You specify and control the number of shards that a stream is composed of. Each open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.
The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets the stream status to CREATING. After the stream is created, Amazon Kinesis sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request if you try to do one of the following:
CREATING state at any point in time.The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
You can use DescribeStream to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of 5 transactions per second per account.
Represents the input for DeleteStream.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException.
If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.
Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.
DeleteStream has a limit of 5 transactions per second per account.
Represents the input for DescribeStream.
Represents the output for DescribeStream.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Describes the specified stream.
The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.
You can limit the number of returned shards using the Limit parameter. The number of shards in a stream may be too large to return from a single call to DescribeStream. You can detect this by using the HasMoreShards flag in the returned output. HasMoreShards is set to true when there is more data available.
DescribeStream is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream.
DescribeStream has a limit of 10 transactions per second per account.
Represents the input for GetRecords.
Represents the output for GetRecords.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.
" - }, - { - "shape":"ExpiredIteratorException", - "exception":true, - "documentation":"The provided iterator exceeds the maximum age allowed.
" - } - ], - "documentation":"Gets data records from a shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. Note that if the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
Each data record can be up to 50 KB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. For example, if your average record size is 40 KB, you can limit the data returned to about 1 MB per call by specifying 25 as the limit.
The size of the data returned by GetRecords will vary depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns 10 MB of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. Note that GetRecords won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to GetRecords; however, it's possible that the application will get exceptions for longer than 1 second.
To detect whether the application is falling behind in processing, add a timestamp to your records and note how long it takes to process them. You can also monitor how much data is in a stream using the CloudWatch metrics for write operations (PutRecord and PutRecords). For more information, see Monitoring Amazon Kinesis with Amazon CloudWatch in the Amazon Kinesis Developer Guide.
Represents the input for GetShardIterator.
Represents the output for GetShardIterator.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.
" - } - ], - "documentation":"Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester.
A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.
You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type, or right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. You can specify the shard iterator type TRIM_HORIZON in the request to cause ShardIterator to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type LATEST, so that you always read the most recent data in the shard.
When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator request to get the first shard iterator to to use in your first GetRecords request and then use the shard iterator returned by the GetRecords request in NextShardIterator for subsequent reads. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords.
If the shard is closed, the iterator can't return more data, and GetShardIterator returns null for its ShardIterator. A shard can be closed using SplitShard or MergeShards.
GetShardIterator has a limit of 5 transactions per second per account per open shard.
Represents the input for ListStreams.
Represents the output for ListStreams.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Lists your streams.
The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Amazon Kinesis uses the default limit, which is currently 10.
You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
ListStreams has a limit of 5 transactions per second per account.
Represents the input for ListTagsForStream.
Represents the output for ListTagsForStream.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Lists the tags for the specified Amazon Kinesis stream.
" - }, - "MergeShards":{ - "name":"MergeShards", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"MergeShardsInput", - "documentation":"Represents the input for MergeShards.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Developer Guide.
If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.
You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.
MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Amazon Kinesis sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException.
MergeShards has limit of 5 transactions per second per account.
Represents the input for PutRecord.
Represents the output for PutRecord.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.
" - } - ], - "documentation":"Puts (writes) a single data record from a producer into an Amazon Kinesis stream. Call PutRecord to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.
Partition keys are Unicode strings, with a maximum length limit of 256 bytes. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Partition Key in the Amazon Kinesis Developer Guide.
PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the SequenceNumberForOrdering parameter. For more information, see Sequence Number in the Amazon Kinesis Developer Guide.
If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
" - }, - "PutRecords":{ - "name":"PutRecords", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PutRecordsInput", - "documentation":"A PutRecords request.
PutRecords results.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"ProvisionedThroughputExceededException", - "exception":true, - "documentation":"The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.
" - } - ], - "documentation":"Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data from a data producer into the Amazon Kinesis stream for real-time ingestion and processing. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Partition Key in the Amazon Kinesis Developer Guide.
Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Developer Guide.
The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.
The response Records array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.
A successfully-processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully-processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled.
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
" - }, - "RemoveTagsFromStream":{ - "name":"RemoveTagsFromStream", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveTagsFromStreamInput", - "documentation":"Represents the input for RemoveTagsFromStream.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Deletes tags from the specified Amazon Kinesis stream.
If you specify a tag that does not exist, it is ignored.
" - }, - "SplitShard":{ - "name":"SplitShard", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SplitShardInput", - "documentation":"Represents the input for SplitShard.
The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - } - ], - "documentation":"Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested.
You can also use SplitShard when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see Split a Shard in the Amazon Kinesis Developer Guide.
You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.
SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Amazon Kinesis sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.
If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.
The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you receive a LimitExceededException.
SplitShard has limit of 5 transactions per second per account.
The name of the stream.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The set of key-value pairs to use to create the tags.
" - } - }, - "documentation":"Represents the input for AddTagsToStream.
A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account, but in two different regions, can have the same name.
" - }, - "ShardCount":{ - "shape":"PositiveIntegerObject", - "documentation":"The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
Note: The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
" - } - }, - "documentation":"Represents the input for CreateStream.
The name of the stream to delete.
" - } - }, - "documentation":"Represents the input for DeleteStream.
The name of the stream to describe.
" - }, - "Limit":{ - "shape":"DescribeStreamInputLimit", - "documentation":"The maximum number of shards to return.
" - }, - "ExclusiveStartShardId":{ - "shape":"ShardId", - "documentation":"The shard ID of the shard to start with.
" - } - }, - "documentation":"Represents the input for DescribeStream.
The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.
" - } - }, - "documentation":"Represents the output for DescribeStream.
A message that provides information about the error.
" - } - }, - "exception":true, - "documentation":"The provided iterator exceeds the maximum age allowed.
" - }, - "GetRecordsInput":{ - "type":"structure", - "required":["ShardIterator"], - "members":{ - "ShardIterator":{ - "shape":"ShardIterator", - "documentation":"The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
" - }, - "Limit":{ - "shape":"GetRecordsInputLimit", - "documentation":"The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
Represents the input for GetRecords.
The data records retrieved from the shard.
" - }, - "NextShardIterator":{ - "shape":"ShardIterator", - "documentation":"The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.
Represents the output for GetRecords.
The name of the stream.
" - }, - "ShardId":{ - "shape":"ShardId", - "documentation":"The shard ID of the shard to get the iterator for.
" - }, - "ShardIteratorType":{ - "shape":"ShardIteratorType", - "documentation":"Determines how the shard iterator is used to start reading data records from the shard.
The following are the valid shard iterator types:
The sequence number of the data record in the shard from which to start reading from.
" - } - }, - "documentation":"Represents the input for GetShardIterator.
The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.
" - } - }, - "documentation":"Represents the output for GetShardIterator.
The starting hash key of the hash key range.
" - }, - "EndingHashKey":{ - "shape":"HashKey", - "documentation":"The ending hash key of the hash key range.
" - } - }, - "documentation":"The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
" - }, - "InvalidArgumentException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A message that provides information about the error.
" - } - }, - "exception":true, - "documentation":"A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A message that provides information about the error.
" - } - }, - "exception":true, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
" - }, - "ListStreamsInput":{ - "type":"structure", - "members":{ - "Limit":{ - "shape":"ListStreamsInputLimit", - "documentation":"The maximum number of streams to list.
" - }, - "ExclusiveStartStreamName":{ - "shape":"StreamName", - "documentation":"The name of the stream to start the list with.
" - } - }, - "documentation":"Represents the input for ListStreams.
The names of the streams that are associated with the AWS account making the ListStreams request.
If set to true, there are more streams available to list.
Represents the output for ListStreams.
The name of the stream.
" - }, - "ExclusiveStartTagKey":{ - "shape":"TagKey", - "documentation":"The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
Represents the input for ListTagsForStream.
A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.
Represents the output for ListTagsForStream.
The name of the stream for the merge.
" - }, - "ShardToMerge":{ - "shape":"ShardId", - "documentation":"The shard ID of the shard to combine with the adjacent shard for the merge.
" - }, - "AdjacentShardToMerge":{ - "shape":"ShardId", - "documentation":"The shard ID of the adjacent shard for the merge.
" - } - }, - "documentation":"Represents the input for MergeShards.
A message that provides information about the error.
" - } - }, - "exception":true, - "documentation":"The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Error Retries and Exponential Backoff in AWS in the AWS General Reference.
" - }, - "PutRecordInput":{ - "type":"structure", - "required":[ - "StreamName", - "Data", - "PartitionKey" - ], - "members":{ - "StreamName":{ - "shape":"StreamName", - "documentation":"The name of the stream to put the data record into.
" - }, - "Data":{ - "shape":"Data", - "documentation":"The data blob to put into the record, which is base64-encoded when the blob is serialized. The maximum size of the data blob (the payload before base64-encoding) is 50 kilobytes (KB)
" - }, - "PartitionKey":{ - "shape":"PartitionKey", - "documentation":"Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 bytes. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key will map to the same shard within the stream.
" - }, - "ExplicitHashKey":{ - "shape":"HashKey", - "documentation":"The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
" - }, - "SequenceNumberForOrdering":{ - "shape":"SequenceNumber", - "documentation":"Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the PutRecordResult when putting record n-1). If this parameter is not set, records will be coarsely ordered based on arrival time.
Represents the input for PutRecord.
The shard ID of the shard where the data record was placed.
" - }, - "SequenceNumber":{ - "shape":"SequenceNumber", - "documentation":"The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.
" - } - }, - "documentation":"Represents the output for PutRecord.
The records associated with the request.
" - }, - "StreamName":{ - "shape":"StreamName", - "documentation":"The stream name associated with the request.
" - } - }, - "documentation":"A PutRecords request.
The number of unsuccessfully processed records in a PutRecords request.
An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to your Amazon Kinesis stream includes SequenceNumber and ShardId in the result. A record that fails to be added to your Amazon Kinesis stream includes ErrorCode and ErrorMessage in the result.
PutRecords results.
The data blob to put into the record, which is base64-encoded when the blob is serialized. The maximum size of the data blob (the payload before base64-encoding) is 50 kilobytes (KB)
" - }, - "ExplicitHashKey":{ - "shape":"HashKey", - "documentation":"The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
" - }, - "PartitionKey":{ - "shape":"PartitionKey", - "documentation":"Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 bytes. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
" - } - }, - "documentation":"Represents the output for PutRecords.
The sequence number for an individual record result.
" - }, - "ShardId":{ - "shape":"ShardId", - "documentation":"The shard ID for an individual record result.
" - }, - "ErrorCode":{ - "shape":"ErrorCode", - "documentation":"The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.
The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message \"Internal Service Failure\".
Represents the result of an individual record from a PutRecords request. A record that is successfully added to your Amazon Kinesis stream includes SequenceNumber and ShardId in the result. A record that fails to be added to your Amazon Kinesis stream includes ErrorCode and ErrorMessage in the result.
The unique identifier for the record in the Amazon Kinesis stream.
" - }, - "Data":{ - "shape":"Data", - "documentation":"The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. The maximum size of the data blob (the payload before base64-encoding) is 50 kilobytes (KB)
" - }, - "PartitionKey":{ - "shape":"PartitionKey", - "documentation":"Identifies which shard in the stream the data record is assigned to.
" - } - }, - "documentation":"The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.
" - }, - "RecordList":{ - "type":"list", - "member":{"shape":"Record"} - }, - "RemoveTagsFromStreamInput":{ - "type":"structure", - "required":[ - "StreamName", - "TagKeys" - ], - "members":{ - "StreamName":{ - "shape":"StreamName", - "documentation":"The name of the stream.
" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"A list of tag keys. Each corresponding tag is removed from the stream.
" - } - }, - "documentation":"Represents the input for RemoveTagsFromStream.
A message that provides information about the error.
" - } - }, - "exception":true, - "documentation":"The resource is not available for this operation. For example, you attempted to split a shard but the stream is not in the ACTIVE state.
A message that provides information about the error.
" - } - }, - "exception":true, - "documentation":"The requested resource could not be found. It might not be specified correctly, or it might not be in the ACTIVE state.
The starting sequence number for the range.
" - }, - "EndingSequenceNumber":{ - "shape":"SequenceNumber", - "documentation":"The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
The range of possible sequence numbers for the shard.
" - }, - "Shard":{ - "type":"structure", - "required":[ - "ShardId", - "HashKeyRange", - "SequenceNumberRange" - ], - "members":{ - "ShardId":{ - "shape":"ShardId", - "documentation":"The unique identifier of the shard within the Amazon Kinesis stream.
" - }, - "ParentShardId":{ - "shape":"ShardId", - "documentation":"The shard Id of the shard's parent.
" - }, - "AdjacentParentShardId":{ - "shape":"ShardId", - "documentation":"The shard Id of the shard adjacent to the shard's parent.
" - }, - "HashKeyRange":{ - "shape":"HashKeyRange", - "documentation":"The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
" - }, - "SequenceNumberRange":{ - "shape":"SequenceNumberRange", - "documentation":"The range of possible sequence numbers for the shard.
" - } - }, - "documentation":"A uniquely identified group of data records in an Amazon Kinesis stream.
" - }, - "ShardId":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[a-zA-Z0-9_.-]+" - }, - "ShardIterator":{ - "type":"string", - "min":1, - "max":512 - }, - "ShardIteratorType":{ - "type":"string", - "enum":[ - "AT_SEQUENCE_NUMBER", - "AFTER_SEQUENCE_NUMBER", - "TRIM_HORIZON", - "LATEST" - ] - }, - "ShardList":{ - "type":"list", - "member":{"shape":"Shard"} - }, - "SplitShardInput":{ - "type":"structure", - "required":[ - "StreamName", - "ShardToSplit", - "NewStartingHashKey" - ], - "members":{ - "StreamName":{ - "shape":"StreamName", - "documentation":"The name of the stream for the shard split.
" - }, - "ShardToSplit":{ - "shape":"ShardId", - "documentation":"The shard ID of the shard to split.
" - }, - "NewStartingHashKey":{ - "shape":"HashKey", - "documentation":"A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
Represents the input for SplitShard.
The name of the stream being described.
" - }, - "StreamARN":{ - "shape":"StreamARN", - "documentation":"The Amazon Resource Name (ARN) for the stream being described.
" - }, - "StreamStatus":{ - "shape":"StreamStatus", - "documentation":"The current status of the stream being described.
The stream status is one of the following states:
CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.The shards that comprise the stream.
" - }, - "HasMoreShards":{ - "shape":"BooleanObject", - "documentation":"If set to true, more shards in the stream are available to describe.
Represents the output for DescribeStream.
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
" - } - }, - "documentation":"Metadata assigned to the stream, consisting of a key-value pair.
" - }, - "TagKey":{ - "type":"string", - "min":1, - "max":128 - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "min":1, - "max":10 - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "min":0 - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "min":1, - "max":10 - }, - "TagValue":{ - "type":"string", - "min":0, - "max":256 - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/kinesis/2013-12-02.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/kinesis/2013-12-02.paginators.json deleted file mode 100644 index 758da301b7..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/kinesis/2013-12-02.paginators.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "pagination": { - "DescribeStream": { - "input_token": "ExclusiveStartShardId", - "limit_key": "Limit", - "more_results": "StreamDescription.HasMoreShards", - "output_token": "StreamDescription.Shards[-1].ShardId", - "result_key": "StreamDescription.Shards", - "non_aggregate_keys": [ - "StreamDescription.StreamARN", - "StreamDescription.StreamName", - "StreamDescription.StreamStatus" - ] - }, - "ListStreams": { - "input_token": "ExclusiveStartStreamName", - "limit_key": "Limit", - "more_results": "HasMoreStreams", - "output_token": "StreamNames[-1]", - "result_key": "StreamNames" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/kinesis/2013-12-02.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/kinesis/2013-12-02.waiters.json deleted file mode 100644 index 8e3162ffa6..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/kinesis/2013-12-02.waiters.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "version": 2, - "waiters": { - "StreamExists": { - "delay": 10, - "operation": "DescribeStream", - "maxAttempts": 18, - "acceptors": [ - { - "expected": "ACTIVE", - "matcher": "path", - "state": "success", - "argument": "StreamDescription.StreamStatus" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/kms/2014-11-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/kms/2014-11-01.normal.json deleted file mode 100644 index 7f6dfa6ab3..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/kms/2014-11-01.normal.json +++ /dev/null @@ -1,2510 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-11-01", - "endpointPrefix":"kms", - "jsonVersion":"1.1", - "serviceAbbreviation":"KMS", - "serviceFullName":"AWS Key Management Service", - "signatureVersion":"v4", - "targetPrefix":"TrentService", - "protocol":"json" - }, - "documentation":"AWS Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS actions that you can call programmatically. For general information about KMS, see (need an address here). For the KMS developer guide, see (need address here).
We recommend that you use the AWS SDKs to make programmatic API calls to KMS. However, you can also use the KMS Query API to make to make direct calls to the KMS web service.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret key for everyday work with KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All KMS operations require Signature Version 4.
Recording API Requests
KMS supports AWS CloudTrail, a service that records AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide
Additional Resources
For more information about credentials and request signing, see the following:
The system timed out while trying to fulfill the request.
" - }, - { - "shape":"AlreadyExistsException", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidAliasNameException", - "error":{ - "code":"InvalidAliasName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified alias name is not valid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a quota was exceeded.
" - } - ], - "documentation":"Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
" - }, - "CreateGrant":{ - "name":"CreateGrant", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateGrantRequest"}, - "output":{"shape":"CreateGrantResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DisabledException", - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - }, - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a quota was exceeded.
" - } - ], - "documentation":"Adds a grant to a key to specify who can access the key and under what conditions. Grants are alternate permission mechanisms to key policies. If absent, access to the key is evaluated based on IAM policies attached to the user. By default, grants do not expire. Grants can be listed, retired, or revoked as indicated by the following APIs. Typically, when you are finished using a grant, you retire it. When you want to end a grant immediately, revoke it. For more information about grants, see Grants.
" - }, - "CreateKey":{ - "name":"CreateKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateKeyRequest"}, - "output":{"shape":"CreateKeyResponse"}, - "errors":[ - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified policy is not syntactically or semantically correct.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"UnsupportedOperationException", - "error":{ - "code":"UnsupportedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified parameter is not supported.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a quota was exceeded.
" - } - ], - "documentation":"Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.
" - }, - "Decrypt":{ - "name":"Decrypt", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DecryptRequest"}, - "output":{"shape":"DecryptResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DisabledException", - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - { - "shape":"InvalidCiphertextException", - "error":{ - "code":"InvalidCiphertext", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
" - }, - { - "shape":"KeyUnavailableException", - "error":{ - "code":"KeyUnavailable", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"The request was rejected because the key was disabled, not found, or otherwise not available.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using the Encrypt function.
" - }, - "DeleteAlias":{ - "name":"DeleteAlias", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAliasRequest"}, - "errors":[ - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Deletes the specified alias.
" - }, - "DescribeKey":{ - "name":"DescribeKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeKeyRequest"}, - "output":{"shape":"DescribeKeyResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Provides detailed information about the specified customer master key.
" - }, - "DisableKey":{ - "name":"DisableKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableKeyRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Marks a key as disabled, thereby preventing its use.
" - }, - "DisableKeyRotation":{ - "name":"DisableKeyRotation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableKeyRotationRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Disables rotation of the specified key." - }, - "EnableKey":{ - "name":"EnableKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableKeyRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a quota was exceeded.
" - } - ], - "documentation":"Marks a key as enabled, thereby permitting its use. You can have up to 25 enabled keys at one time." - }, - "EnableKeyRotation":{ - "name":"EnableKeyRotation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EnableKeyRotationRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Enables rotation of the specified customer master key." - }, - "Encrypt":{ - "name":"Encrypt", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"EncryptRequest"}, - "output":{"shape":"EncryptResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DisabledException", - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - { - "shape":"KeyUnavailableException", - "error":{ - "code":"KeyUnavailable", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"The request was rejected because the key was disabled, not found, or otherwise not available.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidKeyUsageException", - "error":{ - "code":"InvalidKeyUsage", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
" - }, - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Encrypts plaintext into ciphertext by using a customer master key.
" - }, - "GenerateDataKey":{ - "name":"GenerateDataKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateDataKeyRequest"}, - "output":{"shape":"GenerateDataKeyResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DisabledException", - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - { - "shape":"KeyUnavailableException", - "error":{ - "code":"KeyUnavailable", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"The request was rejected because the key was disabled, not found, or otherwise not available.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidKeyUsageException", - "error":{ - "code":"InvalidKeyUsage", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
" - }, - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Generates a secure data key. Data keys are used to encrypt and decrypt data. They are wrapped by customer master keys.
" - }, - "GenerateDataKeyWithoutPlaintext":{ - "name":"GenerateDataKeyWithoutPlaintext", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateDataKeyWithoutPlaintextRequest"}, - "output":{"shape":"GenerateDataKeyWithoutPlaintextResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DisabledException", - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - { - "shape":"KeyUnavailableException", - "error":{ - "code":"KeyUnavailable", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"The request was rejected because the key was disabled, not found, or otherwise not available.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidKeyUsageException", - "error":{ - "code":"InvalidKeyUsage", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
" - }, - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Returns a key wrapped by a customer master key without the plaintext copy of that key. To retrieve the plaintext, see GenerateDataKey.
" - }, - "GenerateRandom":{ - "name":"GenerateRandom", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateRandomRequest"}, - "output":{"shape":"GenerateRandomResponse"}, - "errors":[ - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Generates an unpredictable byte string.
" - }, - "GetKeyPolicy":{ - "name":"GetKeyPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetKeyPolicyRequest"}, - "output":{"shape":"GetKeyPolicyResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Retrieves a policy attached to the specified key.
" - }, - "GetKeyRotationStatus":{ - "name":"GetKeyRotationStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetKeyRotationStatusRequest"}, - "output":{"shape":"GetKeyRotationStatusResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key." - }, - "ListAliases":{ - "name":"ListAliases", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListAliasesRequest"}, - "output":{"shape":"ListAliasesResponse"}, - "errors":[ - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Lists all of the key aliases in the account.
" - }, - "ListGrants":{ - "name":"ListGrants", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGrantsRequest"}, - "output":{"shape":"ListGrantsResponse"}, - "errors":[ - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidMarkerException", - "error":{ - "code":"InvalidMarker", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the marker that specifies where pagination should next begin is not valid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"List the grants for a specified key.
" - }, - "ListKeyPolicies":{ - "name":"ListKeyPolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListKeyPoliciesRequest"}, - "output":{"shape":"ListKeyPoliciesResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Retrieves a list of policies attached to a key.
" - }, - "ListKeys":{ - "name":"ListKeys", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListKeysRequest"}, - "output":{"shape":"ListKeysResponse"}, - "errors":[ - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Lists the customer master keys.
" - }, - "PutKeyPolicy":{ - "name":"PutKeyPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutKeyPolicyRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified policy is not syntactically or semantically correct.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"UnsupportedOperationException", - "error":{ - "code":"UnsupportedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified parameter is not supported.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a quota was exceeded.
" - } - ], - "documentation":"Attaches a policy to the specified key.
" - }, - "ReEncrypt":{ - "name":"ReEncrypt", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ReEncryptRequest"}, - "output":{"shape":"ReEncryptResponse"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DisabledException", - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - { - "shape":"InvalidCiphertextException", - "error":{ - "code":"InvalidCiphertext", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
" - }, - { - "shape":"KeyUnavailableException", - "error":{ - "code":"KeyUnavailable", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"The request was rejected because the key was disabled, not found, or otherwise not available.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"InvalidKeyUsageException", - "error":{ - "code":"InvalidKeyUsage", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
" - }, - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
" - }, - "RetireGrant":{ - "name":"RetireGrant", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RetireGrantRequest"}, - "errors":[ - { - "shape":"InvalidGrantTokenException", - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it." - }, - "RevokeGrant":{ - "name":"RevokeGrant", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RevokeGrantRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ], - "documentation":"Revokes a grant. You can revoke a grant to actively deny operations that depend on it." - }, - "UpdateKeyDescription":{ - "name":"UpdateKeyDescription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateKeyDescriptionRequest"}, - "errors":[ - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - { - "shape":"InvalidArnException", - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - { - "shape":"DependencyTimeoutException", - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - { - "shape":"KMSInternalException", - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - } - ] - } - }, - "shapes":{ - "AWSAccountIdType":{"type":"string"}, - "AliasList":{ - "type":"list", - "member":{"shape":"AliasListEntry"} - }, - "AliasListEntry":{ - "type":"structure", - "members":{ - "AliasName":{ - "shape":"AliasNameType", - "documentation":"String that contains the alias.
" - }, - "AliasArn":{ - "shape":"ArnType", - "documentation":"String that contains the key ARN.
" - }, - "TargetKeyId":{ - "shape":"KeyIdType", - "documentation":"String that contains the key identifier pointed to by the alias.
" - } - }, - "documentation":"Contains information about an alias." - }, - "AliasNameType":{ - "type":"string", - "min":1, - "max":256, - "pattern":"^[a-zA-Z0-9:/_-]+$" - }, - "AlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because it attempted to create a resource that already exists.
" - }, - "ArnType":{ - "type":"string", - "min":20, - "max":2048 - }, - "BooleanType":{"type":"boolean"}, - "CiphertextType":{ - "type":"blob", - "min":1, - "max":6144 - }, - "CreateAliasRequest":{ - "type":"structure", - "required":[ - "AliasName", - "TargetKeyId" - ], - "members":{ - "AliasName":{ - "shape":"AliasNameType", - "documentation":"String that contains the display name. Aliases that begin with AWS are reserved.
" - }, - "TargetKeyId":{ - "shape":"KeyIdType", - "documentation":"An identifier of the key for which you are creating the alias. This value cannot be another alias.
" - } - } - }, - "CreateGrantRequest":{ - "type":"structure", - "required":[ - "KeyId", - "GranteePrincipal" - ], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"A unique key identifier for a customer master key. This value can be a globally unique identifier, an ARN, or an alias.
" - }, - "GranteePrincipal":{ - "shape":"PrincipalIdType", - "documentation":"Principal given permission by the grant to use the key identified by the keyId parameter.
Principal given permission to retire the grant. For more information, see RetireGrant.
" - }, - "Operations":{ - "shape":"GrantOperationList", - "documentation":"List of operations permitted by the grant. This can be any combination of one or more of the following values:
Specifies the conditions under which the actions specified by the Operations parameter are allowed.
List of grant tokens.
" - } - } - }, - "CreateGrantResponse":{ - "type":"structure", - "members":{ - "GrantToken":{ - "shape":"GrantTokenType", - "documentation":"The grant token. A grant token is a string that identifies a grant and which can be used to make a grant take effect immediately. A token contains all of the information necessary to create a grant.
" - }, - "GrantId":{ - "shape":"GrantIdType", - "documentation":"Unique grant identifier. You can use the GrantId value to revoke a grant.
" - } - } - }, - "CreateKeyRequest":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"PolicyType", - "documentation":"Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.
" - }, - "Description":{ - "shape":"DescriptionType", - "documentation":"Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.
" - }, - "KeyUsage":{ - "shape":"KeyUsageType", - "documentation":"Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.
" - } - } - }, - "CreateKeyResponse":{ - "type":"structure", - "members":{ - "KeyMetadata":{ - "shape":"KeyMetadata", - "documentation":"Metadata associated with the key.
" - } - } - }, - "DataKeySpec":{ - "type":"string", - "enum":[ - "AES_256", - "AES_128" - ] - }, - "DateType":{"type":"timestamp"}, - "DecryptRequest":{ - "type":"structure", - "required":["CiphertextBlob"], - "members":{ - "CiphertextBlob":{ - "shape":"CiphertextType", - "documentation":"Ciphertext including metadata.
" - }, - "EncryptionContext":{ - "shape":"EncryptionContextType", - "documentation":"The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
" - }, - "GrantTokens":{ - "shape":"GrantTokenList", - "documentation":"A list of grant tokens that represent grants which can be used to provide long term permissions to perform decryption.
" - } - } - }, - "DecryptResponse":{ - "type":"structure", - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier created by the system for the key. This value is always returned as long as no errors are encountered during the operation.
" - }, - "Plaintext":{ - "shape":"PlaintextType", - "documentation":"Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
" - } - } - }, - "DeleteAliasRequest":{ - "type":"structure", - "required":["AliasName"], - "members":{ - "AliasName":{ - "shape":"AliasNameType", - "documentation":"The alias to be deleted.
" - } - } - }, - "DependencyTimeoutException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"DependencyTimeout", - "httpStatusCode":503 - }, - "exception":true, - "fault":true, - "documentation":"The system timed out while trying to fulfill the request.
" - }, - "DescribeKeyRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the customer master key to be described. This can be an ARN, an alias, or a globally unique identifier.
" - } - } - }, - "DescribeKeyResponse":{ - "type":"structure", - "members":{ - "KeyMetadata":{ - "shape":"KeyMetadata", - "documentation":"Metadata associated with the key.
" - } - } - }, - "DescriptionType":{ - "type":"string", - "min":0, - "max":8192 - }, - "DisableKeyRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the customer master key to be disabled. This can be an ARN, an alias, or a globally unique identifier.
" - } - } - }, - "DisableKeyRotationRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the customer master key for which rotation is to be disabled. This can be an ARN, an alias, or a globally unique identifier.
" - } - } - }, - "DisabledException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"Disabled", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"A request was rejected because the specified key was marked as disabled.
" - }, - "EnableKeyRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the customer master key to be enabled. This can be an ARN, an alias, or a globally unique identifier.
" - } - } - }, - "EnableKeyRotationRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the customer master key for which rotation is to be enabled. This can be an ARN, an alias, or a globally unique identifier.
" - } - } - }, - "EncryptRequest":{ - "type":"structure", - "required":[ - "KeyId", - "Plaintext" - ], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the customer master. This can be an ARN, an alias, or the Key ID.
" - }, - "Plaintext":{ - "shape":"PlaintextType", - "documentation":"Data to be encrypted.
" - }, - "EncryptionContext":{ - "shape":"EncryptionContextType", - "documentation":"Name:value pair that specifies the encryption context to be used for authenticated encryption. For more information, see Authenticated Encryption.
" - }, - "GrantTokens":{ - "shape":"GrantTokenList", - "documentation":"A list of grant tokens that represent grants which can be used to provide long term permissions to perform encryption.
" - } - } - }, - "EncryptResponse":{ - "type":"structure", - "members":{ - "CiphertextBlob":{ - "shape":"CiphertextType", - "documentation":"The encrypted plaintext.
" - }, - "KeyId":{ - "shape":"KeyIdType", - "documentation":"The ID of the key used during encryption.
" - } - } - }, - "EncryptionContextKey":{"type":"string"}, - "EncryptionContextType":{ - "type":"map", - "key":{"shape":"EncryptionContextKey"}, - "value":{"shape":"EncryptionContextValue"} - }, - "EncryptionContextValue":{"type":"string"}, - "ErrorMessageType":{"type":"string"}, - "GenerateDataKeyRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - }, - "EncryptionContext":{ - "shape":"EncryptionContextType", - "documentation":"Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
" - }, - "NumberOfBytes":{ - "shape":"NumberOfBytesType", - "documentation":"Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. 1024 is the current limit.
" - }, - "KeySpec":{ - "shape":"DataKeySpec", - "documentation":"Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
" - }, - "GrantTokens":{ - "shape":"GrantTokenList", - "documentation":"A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
" - } - } - }, - "GenerateDataKeyResponse":{ - "type":"structure", - "members":{ - "CiphertextBlob":{ - "shape":"CiphertextType", - "documentation":"Ciphertext that contains the wrapped key. You must store the blob and encryption context so that the ciphertext can be decrypted. You must provide both the ciphertext blob and the encryption context.
" - }, - "Plaintext":{ - "shape":"PlaintextType", - "documentation":"Plaintext that contains the unwrapped key. Use this for encryption and decryption and then remove it from memory as soon as possible.
" - }, - "KeyId":{ - "shape":"KeyIdType", - "documentation":"System generated unique identifier for the key.
" - } - } - }, - "GenerateDataKeyWithoutPlaintextRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - }, - "EncryptionContext":{ - "shape":"EncryptionContextType", - "documentation":"Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
" - }, - "KeySpec":{ - "shape":"DataKeySpec", - "documentation":"Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
" - }, - "NumberOfBytes":{ - "shape":"NumberOfBytesType", - "documentation":"Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on.
" - }, - "GrantTokens":{ - "shape":"GrantTokenList", - "documentation":"A list of grant tokens that represent grants which can be used to provide long term permissions to generate a key.
" - } - } - }, - "GenerateDataKeyWithoutPlaintextResponse":{ - "type":"structure", - "members":{ - "CiphertextBlob":{ - "shape":"CiphertextType", - "documentation":"Ciphertext that contains the wrapped key. You must store the blob and encryption context so that the key can be used in a future operation.
" - }, - "KeyId":{ - "shape":"KeyIdType", - "documentation":"System generated unique identifier for the key.
" - } - } - }, - "GenerateRandomRequest":{ - "type":"structure", - "members":{ - "NumberOfBytes":{ - "shape":"NumberOfBytesType", - "documentation":"Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes.
" - } - } - }, - "GenerateRandomResponse":{ - "type":"structure", - "members":{ - "Plaintext":{ - "shape":"PlaintextType", - "documentation":"Plaintext that contains the unpredictable byte string.
" - } - } - }, - "GetKeyPolicyRequest":{ - "type":"structure", - "required":[ - "KeyId", - "PolicyName" - ], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - }, - "PolicyName":{ - "shape":"PolicyNameType", - "documentation":"String that contains the name of the policy. Currently, this must be \"default\". Policy names can be discovered by calling ListKeyPolicies.
" - } - } - }, - "GetKeyPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"PolicyType", - "documentation":"A policy document in JSON format.
" - } - } - }, - "GetKeyRotationStatusRequest":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - } - } - }, - "GetKeyRotationStatusResponse":{ - "type":"structure", - "members":{ - "KeyRotationEnabled":{ - "shape":"BooleanType", - "documentation":"A Boolean value that specifies whether key rotation is enabled." - } - } - }, - "GrantConstraints":{ - "type":"structure", - "members":{ - "EncryptionContextSubset":{ - "shape":"EncryptionContextType", - "documentation":"The constraint equals the full encryption context." - }, - "EncryptionContextEquals":{ - "shape":"EncryptionContextType", - "documentation":"The constraint contains additional key/value pairs that serve to further limit the grant." - } - }, - "documentation":"Contains constraints on the grant." - }, - "GrantIdType":{ - "type":"string", - "min":1, - "max":128 - }, - "GrantList":{ - "type":"list", - "member":{"shape":"GrantListEntry"} - }, - "GrantListEntry":{ - "type":"structure", - "members":{ - "GrantId":{ - "shape":"GrantIdType", - "documentation":"Unique grant identifier.
" - }, - "GranteePrincipal":{ - "shape":"PrincipalIdType", - "documentation":"The principal that receives the grant permission.
" - }, - "RetiringPrincipal":{ - "shape":"PrincipalIdType", - "documentation":"The principal that can retire the account.
" - }, - "IssuingAccount":{ - "shape":"PrincipalIdType", - "documentation":"The account under which the grant was issued.
" - }, - "Operations":{ - "shape":"GrantOperationList", - "documentation":"List of operations permitted by the grant. This can be any combination of one or more of the following values:
Specifies the conditions under which the actions specified by the Operations parameter are allowed.
Contains information about each entry in the grant list.
" - }, - "GrantOperation":{ - "type":"string", - "enum":[ - "Decrypt", - "Encrypt", - "GenerateDataKey", - "GenerateDataKeyWithoutPlaintext", - "ReEncryptFrom", - "ReEncryptTo", - "CreateGrant", - "RetireGrant" - ] - }, - "GrantOperationList":{ - "type":"list", - "member":{"shape":"GrantOperation"} - }, - "GrantTokenList":{ - "type":"list", - "member":{"shape":"GrantTokenType"}, - "min":0, - "max":10 - }, - "GrantTokenType":{ - "type":"string", - "min":1, - "max":8192 - }, - "InvalidAliasNameException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"InvalidAliasName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified alias name is not valid.
" - }, - "InvalidArnException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"InvalidArn", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified ARN was not valid.
" - }, - "InvalidCiphertextException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"InvalidCiphertext", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
" - }, - "InvalidGrantTokenException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"InvalidGrantToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A grant token provided as part of the request is invalid.
" - }, - "InvalidKeyUsageException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"InvalidKeyUsage", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
" - }, - "InvalidMarkerException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"InvalidMarker", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the marker that specifies where pagination should next begin is not valid.
" - }, - "KMSInternalException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"KMSInternal", - "httpStatusCode":500 - }, - "exception":true, - "documentation":"The request was rejected because an internal exception occurred. This error can be retried." - }, - "KeyIdType":{ - "type":"string", - "min":1, - "max":256 - }, - "KeyList":{ - "type":"list", - "member":{"shape":"KeyListEntry"} - }, - "KeyListEntry":{ - "type":"structure", - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key.
" - }, - "KeyArn":{ - "shape":"ArnType", - "documentation":"ARN of the key.
" - } - }, - "documentation":"Contains information about each entry in the key list.
" - }, - "KeyMetadata":{ - "type":"structure", - "required":["KeyId"], - "members":{ - "AWSAccountId":{ - "shape":"AWSAccountIdType", - "documentation":"Account ID number.
" - }, - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier for the key.
" - }, - "Arn":{ - "shape":"ArnType", - "documentation":"Key ARN (Amazon Resource Name).
" - }, - "CreationDate":{ - "shape":"DateType", - "documentation":"Date the key was created.
" - }, - "Enabled":{ - "shape":"BooleanType", - "documentation":"Value that specifies whether the key is enabled.
" - }, - "Description":{ - "shape":"DescriptionType", - "documentation":"The description of the key.
" - }, - "KeyUsage":{ - "shape":"KeyUsageType", - "documentation":"A value that specifies what operation(s) the key can perform.
" - } - }, - "documentation":"Contains metadata associated with a specific key." - }, - "KeyUnavailableException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"KeyUnavailable", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"The request was rejected because the key was disabled, not found, or otherwise not available.
" - }, - "KeyUsageType":{ - "type":"string", - "enum":["ENCRYPT_DECRYPT"] - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a quota was exceeded.
" - }, - "LimitType":{ - "type":"integer", - "min":1, - "max":1000 - }, - "ListAliasesRequest":{ - "type":"structure", - "members":{ - "Limit":{ - "shape":"LimitType", - "documentation":"Specify this parameter when paginating results to indicate the maximum number of aliases you want in each response. If there are additional aliases beyond the maximum you specify, the Truncated response element will be set to true.
Use this parameter when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker element in the response you just received.
A list of key aliases in the user's account.
" - }, - "NextMarker":{ - "shape":"MarkerType", - "documentation":"If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.
A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more aliases in the list.
Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - }, - "Limit":{ - "shape":"LimitType", - "documentation":"Specify this parameter only when paginating results to indicate the maximum number of grants you want listed in the response. If there are additional grants beyond the maximum you specify, the Truncated response element will be set to true.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.
A list of grants.
" - }, - "NextMarker":{ - "shape":"MarkerType", - "documentation":"If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.
A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more grants in the list.
Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - }, - "Limit":{ - "shape":"LimitType", - "documentation":"Specify this parameter only when paginating results to indicate the maximum number of policies you want listed in the response. If there are additional policies beyond the maximum you specify, the Truncated response element will be set to true.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.
A list of policy names. Currently, there is only one policy and it is named \"Default\".
" - }, - "NextMarker":{ - "shape":"MarkerType", - "documentation":"If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.
A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policies in the list.
Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.
Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.
A list of keys.
" - }, - "NextMarker":{ - "shape":"MarkerType", - "documentation":"If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.
A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more keys in the list.
The request was rejected because the specified policy is not syntactically or semantically correct.
" - }, - "MarkerType":{ - "type":"string", - "min":1, - "max":320, - "pattern":"[\\u0020-\\u00FF]*" - }, - "NotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the specified entity or resource could not be found.
" - }, - "NumberOfBytesType":{ - "type":"integer", - "min":1, - "max":1024 - }, - "PlaintextType":{ - "type":"blob", - "min":1, - "max":4096, - "sensitive":true - }, - "PolicyNameList":{ - "type":"list", - "member":{"shape":"PolicyNameType"} - }, - "PolicyNameType":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w]+" - }, - "PolicyType":{ - "type":"string", - "min":1, - "max":131072, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "PrincipalIdType":{ - "type":"string", - "min":1, - "max":256 - }, - "PutKeyPolicyRequest":{ - "type":"structure", - "required":[ - "KeyId", - "PolicyName", - "Policy" - ], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key. This can be an ARN, an alias, or a globally unique identifier.
" - }, - "PolicyName":{ - "shape":"PolicyNameType", - "documentation":"Name of the policy to be attached. Currently, the only supported name is \"default\".
" - }, - "Policy":{ - "shape":"PolicyType", - "documentation":"The policy, in JSON format, to be attached to the key.
" - } - } - }, - "ReEncryptRequest":{ - "type":"structure", - "required":[ - "CiphertextBlob", - "DestinationKeyId" - ], - "members":{ - "CiphertextBlob":{ - "shape":"CiphertextType", - "documentation":"Ciphertext of the data to re-encrypt.
" - }, - "SourceEncryptionContext":{ - "shape":"EncryptionContextType", - "documentation":"Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
Key identifier of the key used to re-encrypt the data.
" - }, - "DestinationEncryptionContext":{ - "shape":"EncryptionContextType", - "documentation":"Encryption context to be used when the data is re-encrypted.
" - }, - "GrantTokens":{ - "shape":"GrantTokenList", - "documentation":"Grant tokens that identify the grants that have permissions for the encryption and decryption process.
" - } - } - }, - "ReEncryptResponse":{ - "type":"structure", - "members":{ - "CiphertextBlob":{ - "shape":"CiphertextType", - "documentation":"The re-encrypted data.
" - }, - "SourceKeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key used to originally encrypt the data.
" - }, - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key used to re-encrypt the data.
" - } - } - }, - "RetireGrantRequest":{ - "type":"structure", - "required":["GrantToken"], - "members":{ - "GrantToken":{ - "shape":"GrantTokenType", - "documentation":"Token that identifies the grant to be retired.
" - } - } - }, - "RevokeGrantRequest":{ - "type":"structure", - "required":[ - "KeyId", - "GrantId" - ], - "members":{ - "KeyId":{ - "shape":"KeyIdType", - "documentation":"Unique identifier of the key associated with the grant.
" - }, - "GrantId":{ - "shape":"GrantIdType", - "documentation":"Identifier of the grant to be revoked.
" - } - } - }, - "UnsupportedOperationException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessageType"} - }, - "error":{ - "code":"UnsupportedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because a specified parameter is not supported.
" - }, - "UpdateKeyDescriptionRequest":{ - "type":"structure", - "required":[ - "KeyId", - "Description" - ], - "members":{ - "KeyId":{"shape":"KeyIdType"}, - "Description":{"shape":"DescriptionType"} - } - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/lambda/2014-11-11.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/lambda/2014-11-11.normal.json deleted file mode 100644 index 0d72b1d3d9..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/lambda/2014-11-11.normal.json +++ /dev/null @@ -1,873 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-11-11", - "endpointPrefix":"lambda", - "serviceFullName":"Amazon Lambda", - "signatureVersion":"v4", - "protocol":"rest-json" - }, - "documentation":"Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
", - "operations":{ - "AddEventSource":{ - "name":"AddEventSource", - "http":{ - "method":"POST", - "requestUri":"/2014-11-13/event-source-mappings/" - }, - "input":{"shape":"AddEventSourceRequest"}, - "output":{ - "shape":"EventSourceConfiguration", - "documentation":"Describes mapping between an Amazon Kinesis stream and a Lambda function.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
Identifies an Amazon Kinesis stream as the event source for an AWS Lambda function. AWS Lambda invokes the specified function when records are posted to the stream.
This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.
This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.
The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - } - ], - "documentation":"Deletes the specified Lambda function code and configuration.
This operation requires permission for the lambda:DeleteFunction action.
Describes mapping between an Amazon Kinesis stream and a Lambda function.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
Returns configuration information for the specified event source mapping (see AddEventSource).
This operation requires permission for the lambda:GetEventSource action.
This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - } - ], - "documentation":"Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
This operation requires permission for the lambda:GetFunction action.
A complex type that describes function metadata.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - } - ], - "documentation":"Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.
This operation requires permission for the lambda:GetFunctionConfiguration operation.
Upon success, it returns empty response. Otherwise, throws an exception.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - }, - { - "shape":"InvalidRequestContentException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request body could not be parsed as JSON.
" - } - ], - "documentation":"Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.
This operation requires permission for the lambda:InvokeAsync action.
Contains a list of event sources (see API_EventSourceConfiguration)
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
Returns a list of event source mappings. For each mapping, the API returns configuration information (see AddEventSource). You can optionally specify filters to retrieve specific event source mappings.
This operation requires permission for the lambda:ListEventSources action.
Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - } - ], - "documentation":"Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:RemoveEventSource action.
A complex type that describes function metadata.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
This operation requires permission for the lambda:UpdateFunctionConfiguration action.
A complex type that describes function metadata.
" - }, - "errors":[ - { - "shape":"ServiceException", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
The function or the event source specified in the request does not exist.
" - } - ], - "documentation":"Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.
This operation requires permission for the lambda:UploadFunction action.
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
" - }, - "FunctionName":{ - "shape":"FunctionName", - "documentation":"The Lambda function to invoke when AWS Lambda detects an event on the stream.
" - }, - "Role":{ - "shape":"RoleArn", - "documentation":"The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
" - }, - "BatchSize":{ - "shape":"Integer", - "documentation":"The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.
" - }, - "Parameters":{ - "shape":"Map", - "documentation":"A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: \"TRIM_HORIZON\" and \"LATEST\". The default value is \"TRIM_HORIZON\". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.
The Lambda function to delete.
" - } - } - }, - "Description":{ - "type":"string", - "min":0, - "max":256 - }, - "EventSourceConfiguration":{ - "type":"structure", - "members":{ - "UUID":{ - "shape":"String", - "documentation":"The AWS Lambda assigned opaque identifier for the mapping.
" - }, - "BatchSize":{ - "shape":"Integer", - "documentation":"The largest number of records that AWS Lambda will POST in the invocation request to your function.
" - }, - "EventSource":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.
" - }, - "FunctionName":{ - "shape":"FunctionName", - "documentation":"The Lambda function to invoke when AWS Lambda detects an event on the stream.
" - }, - "Parameters":{ - "shape":"Map", - "documentation":"The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
" - }, - "Role":{ - "shape":"RoleArn", - "documentation":"The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"The UTC time string indicating the last time the event mapping was updated.
" - }, - "IsActive":{ - "shape":"Boolean", - "documentation":"Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.
" - }, - "Status":{ - "shape":"String", - "documentation":"The description of the health of the event source mapping. Valid values are: \"PENDING\", \"OK\", and \"PROBLEM:message\". Initially this staus is \"PENDING\". When AWS Lambda begins processing events, it changes the status to \"OK\".
" - } - }, - "documentation":"Describes mapping between an Amazon Kinesis stream and a Lambda function.
" - }, - "EventSourceList":{ - "type":"list", - "member":{"shape":"EventSourceConfiguration"} - }, - "FunctionArn":{ - "type":"string", - "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?" - }, - "FunctionCodeLocation":{ - "type":"structure", - "members":{ - "RepositoryType":{ - "shape":"String", - "documentation":"The repository from which you can download the function.
" - }, - "Location":{ - "shape":"String", - "documentation":"The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
" - } - }, - "documentation":"The object for the Lambda function location.
" - }, - "FunctionConfiguration":{ - "type":"structure", - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "documentation":"The name of the function.
" - }, - "FunctionARN":{ - "shape":"FunctionArn", - "documentation":"The Amazon Resource Name (ARN) assigned to the function.
" - }, - "ConfigurationId":{ - "shape":"String", - "documentation":"A Lambda-assigned unique identifier for the current function code and related configuration.
" - }, - "Runtime":{ - "shape":"Runtime", - "documentation":"The runtime environment for the Lambda function.
" - }, - "Role":{ - "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
" - }, - "Handler":{ - "shape":"Handler", - "documentation":"The function Lambda calls to begin executing your function.
" - }, - "Mode":{ - "shape":"Mode", - "documentation":"The type of the Lambda function you uploaded.
" - }, - "CodeSize":{ - "shape":"Long", - "documentation":"The size, in bytes, of the function .zip file you uploaded.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The user-provided description.
" - }, - "Timeout":{ - "shape":"Timeout", - "documentation":"The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
" - }, - "MemorySize":{ - "shape":"MemorySize", - "documentation":"The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
" - }, - "LastModified":{ - "shape":"Timestamp", - "documentation":"The timestamp of the last time you updated the function.
" - } - }, - "documentation":"A complex type that describes function metadata.
" - }, - "FunctionList":{ - "type":"list", - "member":{"shape":"FunctionConfiguration"} - }, - "FunctionName":{ - "type":"string", - "min":1, - "max":64, - "pattern":"[a-zA-Z0-9-]+" - }, - "GetEventSourceRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"String", - "location":"uri", - "locationName":"UUID", - "documentation":"The AWS Lambda assigned ID of the event source mapping.
" - } - } - }, - "GetFunctionConfigurationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName", - "documentation":"The name of the Lambda function for which you want to retrieve the configuration information.
" - } - } - }, - "GetFunctionRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName", - "documentation":"The Lambda function name.
" - } - } - }, - "GetFunctionResponse":{ - "type":"structure", - "members":{ - "Configuration":{"shape":"FunctionConfiguration"}, - "Code":{"shape":"FunctionCodeLocation"} - }, - "documentation":"This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation
" - }, - "Handler":{ - "type":"string", - "pattern":"[a-zA-Z0-9./\\-_]+" - }, - "HttpStatus":{"type":"integer"}, - "Integer":{"type":"integer"}, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "message":{"shape":"String"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
The request body could not be parsed as JSON.
" - }, - "InvokeAsyncRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "InvokeArgs" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName", - "documentation":"The Lambda function name.
" - }, - "InvokeArgs":{ - "shape":"Blob", - "documentation":"JSON that you want to provide to your Lambda function as input.
" - } - }, - "payload":"InvokeArgs" - }, - "InvokeAsyncResponse":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"HttpStatus", - "location":"statusCode", - "documentation":"It will be 202 upon success.
" - } - }, - "documentation":"Upon success, it returns empty response. Otherwise, throws an exception.
" - }, - "ListEventSourcesRequest":{ - "type":"structure", - "members":{ - "EventSourceArn":{ - "shape":"String", - "location":"querystring", - "locationName":"EventSource", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Kinesis stream.
" - }, - "FunctionName":{ - "shape":"FunctionName", - "location":"querystring", - "locationName":"FunctionName", - "documentation":"The name of the AWS Lambda function.
" - }, - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker", - "documentation":"Optional string. An opaque pagination token returned from a previous ListEventSources operation. If present, specifies to continue the list from where the returning call left off.
Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.
" - } - } - }, - "ListEventSourcesResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"A string, present if there are more event source mappings.
" - }, - "EventSources":{ - "shape":"EventSourceList", - "documentation":"An arrary of EventSourceConfiguration objects.
Contains a list of event sources (see API_EventSourceConfiguration)
" - }, - "ListFunctionsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "location":"querystring", - "locationName":"Marker", - "documentation":"Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.
Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
" - } - } - }, - "ListFunctionsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"String", - "documentation":"A string, present if there are more functions.
" - }, - "Functions":{ - "shape":"FunctionList", - "documentation":"A list of Lambda functions.
" - } - }, - "documentation":"Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.
" - }, - "Long":{"type":"long"}, - "Map":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "MaxListItems":{ - "type":"integer", - "min":1, - "max":10000 - }, - "MemorySize":{ - "type":"integer", - "min":64, - "max":1024 - }, - "Mode":{ - "type":"string", - "enum":["event"] - }, - "RemoveEventSourceRequest":{ - "type":"structure", - "required":["UUID"], - "members":{ - "UUID":{ - "shape":"String", - "location":"uri", - "locationName":"UUID", - "documentation":"The event source mapping ID.
" - } - } - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The function or the event source specified in the request does not exist.
" - }, - "RoleArn":{ - "type":"string", - "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_]+" - }, - "Runtime":{ - "type":"string", - "enum":["nodejs"] - }, - "ServiceException":{ - "type":"structure", - "members":{ - "Type":{"shape":"String"}, - "Message":{"shape":"String"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"The AWS Lambda service encountered an internal error.
" - }, - "String":{"type":"string"}, - "Timeout":{ - "type":"integer", - "min":1, - "max":60 - }, - "Timestamp":{"type":"timestamp"}, - "UpdateFunctionConfigurationRequest":{ - "type":"structure", - "required":["FunctionName"], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName", - "documentation":"The name of the Lambda function.
" - }, - "Role":{ - "shape":"RoleArn", - "location":"querystring", - "locationName":"Role", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
" - }, - "Handler":{ - "shape":"Handler", - "location":"querystring", - "locationName":"Handler", - "documentation":"The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.
" - }, - "Description":{ - "shape":"Description", - "location":"querystring", - "locationName":"Description", - "documentation":"A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
" - }, - "Timeout":{ - "shape":"Timeout", - "location":"querystring", - "locationName":"Timeout", - "documentation":"The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
" - }, - "MemorySize":{ - "shape":"MemorySize", - "location":"querystring", - "locationName":"MemorySize", - "documentation":"The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
" - } - } - }, - "UploadFunctionRequest":{ - "type":"structure", - "required":[ - "FunctionName", - "FunctionZip", - "Runtime", - "Role", - "Handler", - "Mode" - ], - "members":{ - "FunctionName":{ - "shape":"FunctionName", - "location":"uri", - "locationName":"FunctionName", - "documentation":"The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.
" - }, - "FunctionZip":{ - "shape":"Blob", - "documentation":"A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
" - }, - "Runtime":{ - "shape":"Runtime", - "location":"querystring", - "locationName":"Runtime", - "documentation":"The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only \"nodejs\" as the runtime.
" - }, - "Role":{ - "shape":"RoleArn", - "location":"querystring", - "locationName":"Role", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
" - }, - "Handler":{ - "shape":"Handler", - "location":"querystring", - "locationName":"Handler", - "documentation":"The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.
" - }, - "Mode":{ - "shape":"Mode", - "location":"querystring", - "locationName":"Mode", - "documentation":"How the Lambda function will be invoked. Lambda supports only the \"event\" mode.
" - }, - "Description":{ - "shape":"Description", - "location":"querystring", - "locationName":"Description", - "documentation":"A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
" - }, - "Timeout":{ - "shape":"Timeout", - "location":"querystring", - "locationName":"Timeout", - "documentation":"The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
" - }, - "MemorySize":{ - "shape":"MemorySize", - "location":"querystring", - "locationName":"MemorySize", - "documentation":"The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
" - } - }, - "payload":"FunctionZip" - }, - "Boolean":{"type":"boolean"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/logs/2014-03-28.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/logs/2014-03-28.normal.json deleted file mode 100644 index 63f448e4d9..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/logs/2014-03-28.normal.json +++ /dev/null @@ -1,942 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-03-28", - "endpointPrefix":"logs", - "jsonVersion":"1.1", - "serviceFullName":"Amazon CloudWatch Logs", - "signatureVersion":"v4", - "targetPrefix":"Logs_20140328", - "protocol":"json" - }, - "documentation":"This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs enables you to monitor, store, and access your system, application, and custom log files. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Developer Guide.
Use the following links to get started using the Amazon CloudWatch Logs API Reference:
In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.
Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceAlreadyExistsException", - "exception":true, - "documentation":"Returned if the specified resource already exists.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"Returned if you have reached the maximum number of resources that can be created.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.
You must use the following guidelines when naming a log group:
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceAlreadyExistsException", - "exception":true, - "documentation":"Returned if the specified resource already exists.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.
You must use the following guidelines when naming a log stream:
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
" - }, - "DeleteLogStream":{ - "name":"DeleteLogStream", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLogStreamRequest"}, - "errors":[ - { - "shape":"InvalidParameterException", - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Deletes a log stream and permanently deletes all the archived log events associated with it.
" - }, - "DeleteMetricFilter":{ - "name":"DeleteMetricFilter", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteMetricFilterRequest"}, - "errors":[ - { - "shape":"InvalidParameterException", - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Deletes a metric filter associated with the specified log group.
" - }, - "DeleteRetentionPolicy":{ - "name":"DeleteRetentionPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRetentionPolicyRequest"}, - "errors":[ - { - "shape":"InvalidParameterException", - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.
" - }, - "DescribeLogGroups":{ - "name":"DescribeLogGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLogGroupsRequest"}, - "output":{"shape":"DescribeLogGroupsResponse"}, - "errors":[ - { - "shape":"InvalidParameterException", - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.
By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request.
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":" Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.
By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"InvalidSequenceTokenException", - "exception":true - }, - { - "shape":"DataAlreadyAcceptedException", - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Uploads a batch of log events to the specified log stream.
Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.
The batch of events must satisfy the following constraints:
timestamp.Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"LimitExceededException", - "exception":true, - "documentation":"Returned if you have reached the maximum number of resources that can be created.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":" Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.
Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - { - "shape":"OperationAbortedException", - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
" - }, - "TestMetricFilter":{ - "name":"TestMetricFilter", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TestMetricFilterRequest"}, - "output":{"shape":"TestMetricFilterResponse"}, - "errors":[ - { - "shape":"InvalidParameterException", - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - { - "shape":"ServiceUnavailableException", - "exception":true, - "fault":true, - "documentation":"Returned if the service cannot complete the request.
" - } - ], - "documentation":"Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
" - } - }, - "shapes":{ - "Arn":{"type":"string"}, - "CreateLogGroupRequest":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{"shape":"LogGroupName"} - } - }, - "CreateLogStreamRequest":{ - "type":"structure", - "required":[ - "logGroupName", - "logStreamName" - ], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "logStreamName":{"shape":"LogStreamName"} - } - }, - "DataAlreadyAcceptedException":{ - "type":"structure", - "members":{ - "expectedSequenceToken":{"shape":"SequenceToken"} - }, - "exception":true - }, - "Days":{ - "type":"integer", - "documentation":"Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653." - }, - "DeleteLogGroupRequest":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{"shape":"LogGroupName"} - } - }, - "DeleteLogStreamRequest":{ - "type":"structure", - "required":[ - "logGroupName", - "logStreamName" - ], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "logStreamName":{"shape":"LogStreamName"} - } - }, - "DeleteMetricFilterRequest":{ - "type":"structure", - "required":[ - "logGroupName", - "filterName" - ], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "filterName":{"shape":"FilterName"} - } - }, - "DeleteRetentionPolicyRequest":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{"shape":"LogGroupName"} - } - }, - "DescribeLimit":{ - "type":"integer", - "min":1, - "max":50, - "documentation":"The maximum number of results to return." - }, - "DescribeLogGroupsRequest":{ - "type":"structure", - "members":{ - "logGroupNamePrefix":{"shape":"LogGroupName"}, - "nextToken":{ - "shape":"NextToken", - "documentation":" A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogGroups request.
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
" - } - } - }, - "DescribeLogGroupsResponse":{ - "type":"structure", - "members":{ - "logGroups":{"shape":"LogGroups"}, - "nextToken":{"shape":"NextToken"} - } - }, - "DescribeLogStreamsRequest":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "logStreamNamePrefix":{"shape":"LogStreamName"}, - "nextToken":{ - "shape":"NextToken", - "documentation":" A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
" - } - } - }, - "DescribeLogStreamsResponse":{ - "type":"structure", - "members":{ - "logStreams":{"shape":"LogStreams"}, - "nextToken":{"shape":"NextToken"} - } - }, - "DescribeMetricFiltersRequest":{ - "type":"structure", - "required":["logGroupName"], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "filterNamePrefix":{"shape":"FilterName"}, - "nextToken":{ - "shape":"NextToken", - "documentation":" A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.
The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
" - } - } - }, - "DescribeMetricFiltersResponse":{ - "type":"structure", - "members":{ - "metricFilters":{"shape":"MetricFilters"}, - "nextToken":{"shape":"NextToken"} - } - }, - "EventMessage":{ - "type":"string", - "min":1, - "max":32768 - }, - "EventNumber":{"type":"long"}, - "EventsLimit":{ - "type":"integer", - "min":1, - "max":10000, - "documentation":"The maximum number of events to return." - }, - "ExtractedValues":{ - "type":"map", - "key":{"shape":"Token"}, - "value":{"shape":"Value"} - }, - "FilterCount":{ - "type":"integer", - "documentation":"The number of metric filters associated with the log group." - }, - "FilterName":{ - "type":"string", - "min":1, - "max":512, - "pattern":"[^:*]*", - "documentation":"The name of the metric filter." - }, - "FilterPattern":{ - "type":"string", - "min":0, - "max":512, - "documentation":"A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream." - }, - "GetLogEventsRequest":{ - "type":"structure", - "required":[ - "logGroupName", - "logStreamName" - ], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "logStreamName":{"shape":"LogStreamName"}, - "startTime":{"shape":"Timestamp"}, - "endTime":{"shape":"Timestamp"}, - "nextToken":{ - "shape":"NextToken", - "documentation":" A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.
The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events as can fit in a response size of 1MB, up to 10,000 log events.
" - }, - "startFromHead":{ - "shape":"StartFromHead", - "documentation":"If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first)." - } - } - }, - "GetLogEventsResponse":{ - "type":"structure", - "members":{ - "events":{"shape":"OutputLogEvents"}, - "nextForwardToken":{"shape":"NextToken"}, - "nextBackwardToken":{"shape":"NextToken"} - } - }, - "InputLogEvent":{ - "type":"structure", - "required":[ - "timestamp", - "message" - ], - "members":{ - "timestamp":{"shape":"Timestamp"}, - "message":{"shape":"EventMessage"} - }, - "documentation":"A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that Amazon CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message." - }, - "InputLogEvents":{ - "type":"list", - "member":{"shape":"InputLogEvent"}, - "min":1, - "max":1000, - "documentation":"A list of events belonging to a log stream." - }, - "InvalidParameterException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"Returned if a parameter of the request is incorrectly specified.
" - }, - "InvalidSequenceTokenException":{ - "type":"structure", - "members":{ - "expectedSequenceToken":{"shape":"SequenceToken"} - }, - "exception":true - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"Returned if you have reached the maximum number of resources that can be created.
" - }, - "LogGroup":{ - "type":"structure", - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "creationTime":{"shape":"Timestamp"}, - "retentionInDays":{"shape":"Days"}, - "metricFilterCount":{"shape":"FilterCount"}, - "arn":{"shape":"Arn"}, - "storedBytes":{"shape":"StoredBytes"} - } - }, - "LogGroupName":{ - "type":"string", - "min":1, - "max":512, - "pattern":"[\\.\\-_/#A-Za-z0-9]+" - }, - "LogGroups":{ - "type":"list", - "member":{"shape":"LogGroup"}, - "documentation":"A list of log groups." - }, - "LogStream":{ - "type":"structure", - "members":{ - "logStreamName":{"shape":"LogStreamName"}, - "creationTime":{"shape":"Timestamp"}, - "firstEventTimestamp":{"shape":"Timestamp"}, - "lastEventTimestamp":{"shape":"Timestamp"}, - "lastIngestionTime":{"shape":"Timestamp"}, - "uploadSequenceToken":{"shape":"SequenceToken"}, - "arn":{"shape":"Arn"}, - "storedBytes":{"shape":"StoredBytes"} - }, - "documentation":"A log stream is sequence of log events that share the same emitter." - }, - "LogStreamName":{ - "type":"string", - "min":1, - "max":512, - "pattern":"[^:*]*" - }, - "LogStreams":{ - "type":"list", - "member":{"shape":"LogStream"}, - "documentation":"A list of log streams." - }, - "MetricFilter":{ - "type":"structure", - "members":{ - "filterName":{"shape":"FilterName"}, - "filterPattern":{"shape":"FilterPattern"}, - "metricTransformations":{"shape":"MetricTransformations"}, - "creationTime":{"shape":"Timestamp"} - }, - "documentation":"Metric filters can be used to express how Amazon CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric." - }, - "MetricFilterMatchRecord":{ - "type":"structure", - "members":{ - "eventNumber":{"shape":"EventNumber"}, - "eventMessage":{"shape":"EventMessage"}, - "extractedValues":{"shape":"ExtractedValues"} - } - }, - "MetricFilterMatches":{ - "type":"list", - "member":{"shape":"MetricFilterMatchRecord"} - }, - "MetricFilters":{ - "type":"list", - "member":{"shape":"MetricFilter"} - }, - "MetricName":{ - "type":"string", - "max":255, - "pattern":"[^:*$]*", - "documentation":"The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount." - }, - "MetricNamespace":{ - "type":"string", - "max":255, - "pattern":"[^:*$]*", - "documentation":"The destination namespace of the new CloudWatch metric." - }, - "MetricTransformation":{ - "type":"structure", - "required":[ - "metricName", - "metricNamespace", - "metricValue" - ], - "members":{ - "metricName":{"shape":"MetricName"}, - "metricNamespace":{"shape":"MetricNamespace"}, - "metricValue":{"shape":"MetricValue"} - } - }, - "MetricTransformations":{ - "type":"list", - "member":{"shape":"MetricTransformation"}, - "min":1, - "max":1 - }, - "MetricValue":{ - "type":"string", - "max":100, - "documentation":"What to publish to the metric. For example, if you're counting the occurrences of a particular term like \"Error\", the value will be \"1\" for each occurrence. If you're counting the bytes transferred the published value will be the value in the log event." - }, - "NextToken":{ - "type":"string", - "documentation":"A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours." - }, - "OperationAbortedException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"Returned if multiple requests to update the same resource were in conflict.
" - }, - "OutputLogEvent":{ - "type":"structure", - "members":{ - "timestamp":{"shape":"Timestamp"}, - "message":{"shape":"EventMessage"}, - "ingestionTime":{"shape":"Timestamp"} - } - }, - "OutputLogEvents":{ - "type":"list", - "member":{"shape":"OutputLogEvent"} - }, - "PutLogEventsRequest":{ - "type":"structure", - "required":[ - "logGroupName", - "logStreamName", - "logEvents" - ], - "members":{ - "logGroupName":{"shape":"LogGroupName"}, - "logStreamName":{"shape":"LogStreamName"}, - "logEvents":{"shape":"InputLogEvents"}, - "sequenceToken":{ - "shape":"SequenceToken", - "documentation":" A string token that must be obtained from the response of the previous PutLogEvents request.
Returned if the specified resource already exists.
" - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"Returned if the specified resource does not exist.
" - }, - "SequenceToken":{ - "type":"string", - "min":1, - "documentation":"A string token used for making PutLogEvents requests. AsequenceToken can only be used once, and PutLogEvents requests must include the sequenceToken obtained from the response of the previous request."
- },
- "ServiceUnavailableException":{
- "type":"structure",
- "members":{
- },
- "exception":true,
- "fault":true,
- "documentation":"Returned if the service cannot complete the request.
" - }, - "StartFromHead":{"type":"boolean"}, - "StoredBytes":{ - "type":"long", - "min":0 - }, - "TestEventMessages":{ - "type":"list", - "member":{"shape":"EventMessage"}, - "min":1, - "max":50 - }, - "TestMetricFilterRequest":{ - "type":"structure", - "required":[ - "filterPattern", - "logEventMessages" - ], - "members":{ - "filterPattern":{"shape":"FilterPattern"}, - "logEventMessages":{"shape":"TestEventMessages"} - } - }, - "TestMetricFilterResponse":{ - "type":"structure", - "members":{ - "matches":{"shape":"MetricFilterMatches"} - } - }, - "Timestamp":{ - "type":"long", - "min":0, - "documentation":"A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC." - }, - "Token":{"type":"string"}, - "Value":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/opsworks/2013-02-18.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/opsworks/2013-02-18.normal.json deleted file mode 100644 index be4d94343e..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/opsworks/2013-02-18.normal.json +++ /dev/null @@ -1,4727 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2013-02-18", - "endpointPrefix":"opsworks", - "jsonVersion":"1.1", - "serviceFullName":"AWS OpsWorks", - "signatureVersion":"v4", - "targetPrefix":"OpsWorks_20130218", - "protocol":"json" - }, - "documentation":"Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.
AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.10. For more information, see Chef Versions.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Assign a registered instance to a custom layer. You cannot use this action with instances that were created with AWS OpsWorks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "AssignVolume":{ - "name":"AssignVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssignVolumeRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "AssociateElasticIp":{ - "name":"AssociateElasticIp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssociateElasticIpRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "AttachElasticLoadBalancer":{ - "name":"AttachElasticLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachElasticLoadBalancerRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CloneStack":{ - "name":"CloneStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CloneStackRequest"}, - "output":{ - "shape":"CloneStackResult", - "documentation":"Contains the response to a CloneStack request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Creates a clone of a specified stack. For more information, see Clone a Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CreateApp":{ - "name":"CreateApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateAppRequest"}, - "output":{ - "shape":"CreateAppResult", - "documentation":"Contains the response to a CreateApp request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CreateDeployment":{ - "name":"CreateDeployment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDeploymentRequest"}, - "output":{ - "shape":"CreateDeploymentResult", - "documentation":"Contains the response to a CreateDeployment request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CreateInstance":{ - "name":"CreateInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateInstanceRequest"}, - "output":{ - "shape":"CreateInstanceResult", - "documentation":"Contains the response to a CreateInstance request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CreateLayer":{ - "name":"CreateLayer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateLayerRequest"}, - "output":{ - "shape":"CreateLayerResult", - "documentation":"Contains the response to a CreateLayer request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CreateStack":{ - "name":"CreateStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateStackRequest"}, - "output":{ - "shape":"CreateStackResult", - "documentation":"Contains the response to a CreateStack request.
Indicates that a request was invalid.
" - } - ], - "documentation":"Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "CreateUserProfile":{ - "name":"CreateUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateUserProfileRequest"}, - "output":{ - "shape":"CreateUserProfileResult", - "documentation":"Contains the response to a CreateUserProfile request.
Indicates that a request was invalid.
" - } - ], - "documentation":"Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeleteApp":{ - "name":"DeleteApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAppRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeleteInstance":{ - "name":"DeleteInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeleteLayer":{ - "name":"DeleteLayer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLayerRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeleteStack":{ - "name":"DeleteStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteStackRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeleteUserProfile":{ - "name":"DeleteUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteUserProfileRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeregisterElasticIp":{ - "name":"DeregisterElasticIp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterElasticIpRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeregisterInstance":{ - "name":"DeregisterInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeregisterRdsDbInstance":{ - "name":"DeregisterRdsDbInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterRdsDbInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DeregisterVolume":{ - "name":"DeregisterVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeregisterVolumeRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeApps":{ - "name":"DescribeApps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAppsRequest"}, - "output":{ - "shape":"DescribeAppsResult", - "documentation":"Contains the response to a DescribeApps request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Requests a description of a specified set of apps.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeCommands":{ - "name":"DescribeCommands", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCommandsRequest"}, - "output":{ - "shape":"DescribeCommandsResult", - "documentation":"Contains the response to a DescribeCommands request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes the results of specified commands.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeDeployments":{ - "name":"DescribeDeployments", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDeploymentsRequest"}, - "output":{ - "shape":"DescribeDeploymentsResult", - "documentation":"Contains the response to a DescribeDeployments request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Requests a description of a specified set of deployments.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeElasticIps":{ - "name":"DescribeElasticIps", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeElasticIpsRequest"}, - "output":{ - "shape":"DescribeElasticIpsResult", - "documentation":"Contains the response to a DescribeElasticIps request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes Elastic IP addresses.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeElasticLoadBalancers":{ - "name":"DescribeElasticLoadBalancers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeElasticLoadBalancersRequest"}, - "output":{ - "shape":"DescribeElasticLoadBalancersResult", - "documentation":"Contains the response to a DescribeElasticLoadBalancers request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes a stack's Elastic Load Balancing instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeInstances":{ - "name":"DescribeInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeInstancesRequest"}, - "output":{ - "shape":"DescribeInstancesResult", - "documentation":"Contains the response to a DescribeInstances request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Requests a description of a set of instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeLayers":{ - "name":"DescribeLayers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLayersRequest"}, - "output":{ - "shape":"DescribeLayersResult", - "documentation":"Contains the response to a DescribeLayers request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Requests a description of one or more layers in a specified stack.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeLoadBasedAutoScaling":{ - "name":"DescribeLoadBasedAutoScaling", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLoadBasedAutoScalingRequest"}, - "output":{ - "shape":"DescribeLoadBasedAutoScalingResult", - "documentation":"Contains the response to a DescribeLoadBasedAutoScaling request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeMyUserProfile":{ - "name":"DescribeMyUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeMyUserProfileResult", - "documentation":"Contains the response to a DescribeMyUserProfile request.
Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribePermissions":{ - "name":"DescribePermissions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePermissionsRequest"}, - "output":{ - "shape":"DescribePermissionsResult", - "documentation":"Contains the response to a DescribePermissions request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeRaidArrays":{ - "name":"DescribeRaidArrays", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRaidArraysRequest"}, - "output":{ - "shape":"DescribeRaidArraysResult", - "documentation":"Contains the response to a DescribeRaidArrays request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describe an instance's RAID arrays.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeRdsDbInstances":{ - "name":"DescribeRdsDbInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeRdsDbInstancesRequest"}, - "output":{ - "shape":"DescribeRdsDbInstancesResult", - "documentation":"Contains the response to a DescribeRdsDbInstances request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeServiceErrors":{ - "name":"DescribeServiceErrors", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeServiceErrorsRequest"}, - "output":{ - "shape":"DescribeServiceErrorsResult", - "documentation":"Contains the response to a DescribeServiceErrors request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeStackProvisioningParameters":{ - "name":"DescribeStackProvisioningParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStackProvisioningParametersRequest"}, - "output":{ - "shape":"DescribeStackProvisioningParametersResult", - "documentation":"Contains the response to a DescribeStackProvisioningParameters request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeStackSummary":{ - "name":"DescribeStackSummary", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStackSummaryRequest"}, - "output":{ - "shape":"DescribeStackSummaryResult", - "documentation":"Contains the response to a DescribeStackSummary request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeStacks":{ - "name":"DescribeStacks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStacksRequest"}, - "output":{ - "shape":"DescribeStacksResult", - "documentation":"Contains the response to a DescribeStacks request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeTimeBasedAutoScaling":{ - "name":"DescribeTimeBasedAutoScaling", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTimeBasedAutoScalingRequest"}, - "output":{ - "shape":"DescribeTimeBasedAutoScalingResult", - "documentation":"Contains the response to a DescribeTimeBasedAutoScaling request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeUserProfiles":{ - "name":"DescribeUserProfiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeUserProfilesRequest"}, - "output":{ - "shape":"DescribeUserProfilesResult", - "documentation":"Contains the response to a DescribeUserProfiles request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DescribeVolumes":{ - "name":"DescribeVolumes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeVolumesRequest"}, - "output":{ - "shape":"DescribeVolumesResult", - "documentation":"Contains the response to a DescribeVolumes request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Describes an instance's Amazon EBS volumes.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DetachElasticLoadBalancer":{ - "name":"DetachElasticLoadBalancer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachElasticLoadBalancerRequest"}, - "errors":[ - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "DisassociateElasticIp":{ - "name":"DisassociateElasticIp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisassociateElasticIpRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "GetHostnameSuggestion":{ - "name":"GetHostnameSuggestion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetHostnameSuggestionRequest"}, - "output":{ - "shape":"GetHostnameSuggestionResult", - "documentation":"Contains the response to a GetHostnameSuggestion request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "RebootInstance":{ - "name":"RebootInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RebootInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "RegisterElasticIp":{ - "name":"RegisterElasticIp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterElasticIpRequest"}, - "output":{ - "shape":"RegisterElasticIpResult", - "documentation":"Contains the response to a RegisterElasticIp request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "RegisterInstance":{ - "name":"RegisterInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterInstanceRequest"}, - "output":{ - "shape":"RegisterInstanceResult", - "documentation":"Contains the response to a RegisterInstanceResult request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Registers instances with a specified stack that were created outside of AWS OpsWorks.
RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation.Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "RegisterRdsDbInstance":{ - "name":"RegisterRdsDbInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterRdsDbInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "RegisterVolume":{ - "name":"RegisterVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterVolumeRequest"}, - "output":{ - "shape":"RegisterVolumeResult", - "documentation":"Contains the response to a RegisterVolume request.
Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "SetLoadBasedAutoScaling":{ - "name":"SetLoadBasedAutoScaling", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetLoadBasedAutoScalingRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "SetPermission":{ - "name":"SetPermission", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetPermissionRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "SetTimeBasedAutoScaling":{ - "name":"SetTimeBasedAutoScaling", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetTimeBasedAutoScalingRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "StartInstance":{ - "name":"StartInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "StartStack":{ - "name":"StartStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartStackRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "StopInstance":{ - "name":"StopInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "StopStack":{ - "name":"StopStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopStackRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UnassignInstance":{ - "name":"UnassignInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UnassignInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UnassignVolume":{ - "name":"UnassignVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UnassignVolumeRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateApp":{ - "name":"UpdateApp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateAppRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateElasticIp":{ - "name":"UpdateElasticIp", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateElasticIpRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateInstance":{ - "name":"UpdateInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateLayer":{ - "name":"UpdateLayer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateLayerRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateMyUserProfile":{ - "name":"UpdateMyUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateMyUserProfileRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - } - ], - "documentation":"Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateRdsDbInstance":{ - "name":"UpdateRdsDbInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRdsDbInstanceRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateStack":{ - "name":"UpdateStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateStackRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateUserProfile":{ - "name":"UpdateUserProfile", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateUserProfileRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - }, - "UpdateVolume":{ - "name":"UpdateVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateVolumeRequest"}, - "errors":[ - { - "shape":"ValidationException", - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - { - "shape":"ResourceNotFoundException", - "exception":true, - "documentation":"Indicates that a resource was not found.
" - } - ], - "documentation":"Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" - } - }, - "shapes":{ - "App":{ - "type":"structure", - "members":{ - "AppId":{ - "shape":"String", - "documentation":"The app ID.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The app stack ID.
" - }, - "Shortname":{ - "shape":"String", - "documentation":"The app's short name.
" - }, - "Name":{ - "shape":"String", - "documentation":"The app name.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the app.
" - }, - "DataSources":{ - "shape":"DataSources", - "documentation":"The app's data sources.
" - }, - "Type":{ - "shape":"AppType", - "documentation":"The app type.
" - }, - "AppSource":{ - "shape":"Source", - "documentation":"A Source object that describes the app repository.
The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether to enable SSL for the app.
" - }, - "SslConfiguration":{ - "shape":"SslConfiguration", - "documentation":"An SslConfiguration object with the SSL configuration.
The stack attributes.
" - }, - "CreatedAt":{ - "shape":"String", - "documentation":"When the app was created.
" - }, - "Environment":{ - "shape":"EnvironmentVariables", - "documentation":"An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instances.
A description of the app.
" - }, - "AppAttributes":{ - "type":"map", - "key":{"shape":"AppAttributesKeys"}, - "value":{"shape":"String"} - }, - "AppAttributesKeys":{ - "type":"string", - "enum":[ - "DocumentRoot", - "RailsEnv", - "AutoBundleOnDeploy" - ] - }, - "AppType":{ - "type":"string", - "enum":[ - "java", - "rails", - "php", - "nodejs", - "static", - "other" - ] - }, - "Apps":{ - "type":"list", - "member":{"shape":"App"} - }, - "Architecture":{ - "type":"string", - "enum":[ - "x86_64", - "i386" - ] - }, - "AssignInstanceRequest":{ - "type":"structure", - "required":[ - "InstanceId", - "LayerIds" - ], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "LayerIds":{ - "shape":"Strings", - "documentation":"The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.
" - } - } - }, - "AssignVolumeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "AssociateElasticIpRequest":{ - "type":"structure", - "required":["ElasticIp"], - "members":{ - "ElasticIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "AttachElasticLoadBalancerRequest":{ - "type":"structure", - "required":[ - "ElasticLoadBalancerName", - "LayerId" - ], - "members":{ - "ElasticLoadBalancerName":{ - "shape":"String", - "documentation":"The Elastic Load Balancing instance's name.
" - }, - "LayerId":{ - "shape":"String", - "documentation":"The ID of the layer that the Elastic Load Balancing instance is to be attached to.
" - } - } - }, - "AutoScalingThresholds":{ - "type":"structure", - "members":{ - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of instances to add or remove when the load exceeds a threshold.
" - }, - "ThresholdsWaitTime":{ - "shape":"Minute", - "documentation":"The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
" - }, - "IgnoreMetricsTime":{ - "shape":"Minute", - "documentation":"The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough to get the new instances online.
The CPU utilization threshold, as a percent of the available CPU.
" - }, - "MemoryThreshold":{ - "shape":"Double", - "documentation":"The memory utilization threshold, as a percent of the available memory.
" - }, - "LoadThreshold":{ - "shape":"Double", - "documentation":"The load threshold. For more information about how load is computed, see Load (computing).
" - } - }, - "documentation":"Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks starts or stops load-based instances.
" - }, - "AutoScalingType":{ - "type":"string", - "enum":[ - "load", - "timer" - ] - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "ChefConfiguration":{ - "type":"structure", - "members":{ - "ManageBerkshelf":{ - "shape":"Boolean", - "documentation":"Whether to enable Berkshelf.
" - }, - "BerkshelfVersion":{ - "shape":"String", - "documentation":"The Berkshelf version.
" - } - }, - "documentation":"Describes the Chef configuration.
" - }, - "CloneStackRequest":{ - "type":"structure", - "required":[ - "SourceStackId", - "ServiceRoleArn" - ], - "members":{ - "SourceStackId":{ - "shape":"String", - "documentation":"The source stack ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The cloned stack name.
" - }, - "Region":{ - "shape":"String", - "documentation":"The cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
" - }, - "Attributes":{ - "shape":"StackAttributes", - "documentation":"A list of stack attributes and values as key/value pairs to be added to the cloned stack.
" - }, - "ServiceRoleArn":{ - "shape":"String", - "documentation":"The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "DefaultOs":{ - "shape":"String", - "documentation":"The stacks's operating system, which must be set to one of the following.
Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.Custom. You specify the custom AMI you want to use when you create instances.The default option is the current Amazon Linux version.
" - }, - "HostnameTheme":{ - "shape":"String", - "documentation":"The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
" - }, - "ConfigurationManager":{ - "shape":"StackConfigurationManager", - "documentation":"The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.
" - }, - "ChefConfiguration":{ - "shape":"ChefConfiguration", - "documentation":"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Whether to use custom cookbooks.
" - }, - "UseOpsworksSecurityGroups":{ - "shape":"Boolean", - "documentation":"Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
" - }, - "CustomCookbooksSource":{"shape":"Source"}, - "DefaultSshKeyName":{ - "shape":"String", - "documentation":"A default SSH key for the stack instances. You can override this value when you create or update an instance.
" - }, - "ClonePermissions":{ - "shape":"Boolean", - "documentation":"Whether to clone the source stack's permissions.
" - }, - "CloneAppIds":{ - "shape":"Strings", - "documentation":"A list of source stack app IDs to be included in the cloned stack.
" - }, - "DefaultRootDeviceType":{ - "shape":"RootDeviceType", - "documentation":"The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
" - } - } - }, - "CloneStackResult":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The cloned stack ID.
" - } - }, - "documentation":"Contains the response to a CloneStack request.
The command ID.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance where the command was executed.
" - }, - "DeploymentId":{ - "shape":"String", - "documentation":"The command deployment ID.
" - }, - "CreatedAt":{ - "shape":"DateTime", - "documentation":"Date and time when the command was run.
" - }, - "AcknowledgedAt":{ - "shape":"DateTime", - "documentation":"Date and time when the command was acknowledged.
" - }, - "CompletedAt":{ - "shape":"DateTime", - "documentation":"Date when the command completed.
" - }, - "Status":{ - "shape":"String", - "documentation":"The command status:
The command exit code.
" - }, - "LogUrl":{ - "shape":"String", - "documentation":"The URL of the command log.
" - }, - "Type":{ - "shape":"String", - "documentation":"The command type:
deployrollbackstartstoprestartundeployupdate_dependenciesinstall_dependenciesupdate_custom_cookbooksexecute_recipesDescribes a command.
" - }, - "Commands":{ - "type":"list", - "member":{"shape":"Command"} - }, - "CreateAppRequest":{ - "type":"structure", - "required":[ - "StackId", - "Name", - "Type" - ], - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "Shortname":{ - "shape":"String", - "documentation":"The app's short name.
" - }, - "Name":{ - "shape":"String", - "documentation":"The app name.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the app.
" - }, - "DataSources":{ - "shape":"DataSources", - "documentation":"The app's data source.
" - }, - "Type":{ - "shape":"AppType", - "documentation":"The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer.
" - }, - "AppSource":{ - "shape":"Source", - "documentation":"A Source object that specifies the app repository.
The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether to enable SSL for the app.
" - }, - "SslConfiguration":{ - "shape":"SslConfiguration", - "documentation":"An SslConfiguration object with the SSL configuration.
One or more user-defined key/value pairs to be added to the stack attributes.
" - }, - "Environment":{ - "shape":"EnvironmentVariables", - "documentation":"An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instance.
The app ID.
" - } - }, - "documentation":"Contains the response to a CreateApp request.
The stack ID.
" - }, - "AppId":{ - "shape":"String", - "documentation":"The app ID. This parameter is required for app deployments, but not for other deployment commands.
" - }, - "InstanceIds":{ - "shape":"Strings", - "documentation":"The instance IDs for the deployment targets.
" - }, - "Command":{ - "shape":"DeploymentCommand", - "documentation":"A DeploymentCommand object that specifies the deployment command and any associated arguments.
A user-defined comment.
" - }, - "CustomJson":{ - "shape":"String", - "documentation":"A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
" - } - } - }, - "CreateDeploymentResult":{ - "type":"structure", - "members":{ - "DeploymentId":{ - "shape":"String", - "documentation":"The deployment ID, which can be used with other requests to identify the deployment.
" - } - }, - "documentation":"Contains the response to a CreateDeployment request.
The stack ID.
" - }, - "LayerIds":{ - "shape":"Strings", - "documentation":"An array that contains the instance layer IDs.
" - }, - "InstanceType":{ - "shape":"String", - "documentation":"The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
" - }, - "AutoScalingType":{ - "shape":"AutoScalingType", - "documentation":"For load-based or time-based instances, the type.
" - }, - "Hostname":{ - "shape":"String", - "documentation":"The instance host name.
" - }, - "Os":{ - "shape":"String", - "documentation":"The instance's operating system, which must be set to one of the following.
Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.Custom The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances.
Os to Custom.The instance SSH key name.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The instance Availability Zone. For more information, see Regions and Endpoints.
" - }, - "VirtualizationType":{ - "shape":"String", - "documentation":"The instance's virtualization type, paravirtual or hvm.
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.
" - }, - "Architecture":{ - "shape":"Architecture", - "documentation":"The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
The instance root device type. For more information, see Storage for the Root Device.
" - }, - "InstallUpdatesOnBoot":{ - "shape":"Boolean", - "documentation":"Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true to ensure that your instances have the latest security updates.
Whether to create an Amazon EBS-optimized instance.
" - } - } - }, - "CreateInstanceResult":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - }, - "documentation":"Contains the response to a CreateInstance request.
The layer stack ID.
" - }, - "Type":{ - "shape":"LayerType", - "documentation":"The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
" - }, - "Name":{ - "shape":"String", - "documentation":"The layer name, which is used by the console.
" - }, - "Shortname":{ - "shape":"String", - "documentation":"The layer short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
" - }, - "Attributes":{ - "shape":"LayerAttributes", - "documentation":"One or more user-defined key/value pairs to be added to the stack attributes.
" - }, - "CustomInstanceProfileArn":{ - "shape":"String", - "documentation":"The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "CustomSecurityGroupIds":{ - "shape":"Strings", - "documentation":"An array containing the layer custom security group IDs.
" - }, - "Packages":{ - "shape":"Strings", - "documentation":"An array of Package objects that describe the layer packages.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether to disable auto healing for the layer.
" - }, - "AutoAssignElasticIps":{ - "shape":"Boolean", - "documentation":"Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
" - }, - "AutoAssignPublicIps":{ - "shape":"Boolean", - "documentation":"For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
" - }, - "CustomRecipes":{ - "shape":"Recipes", - "documentation":"A LayerCustomRecipes object that specifies the layer custom recipes.
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether to use Amazon EBS-optimized instances.
" - }, - "LifecycleEventConfiguration":{ - "shape":"LifecycleEventConfiguration", - "documentation":"A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
" - } - } - }, - "CreateLayerResult":{ - "type":"structure", - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - } - }, - "documentation":"Contains the response to a CreateLayer request.
The stack name.
" - }, - "Region":{ - "shape":"String", - "documentation":"The stack AWS region, such as \"us-east-1\". For more information about Amazon regions, see Regions and Endpoints.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC that the stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
" - }, - "Attributes":{ - "shape":"StackAttributes", - "documentation":"One or more user-defined key/value pairs to be added to the stack attributes.
" - }, - "ServiceRoleArn":{ - "shape":"String", - "documentation":"The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
" - }, - "DefaultInstanceProfileArn":{ - "shape":"String", - "documentation":"The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "DefaultOs":{ - "shape":"String", - "documentation":"The stack's operating system, which must be set to one of the following.
Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.Custom. You specify the custom AMI you want to use when you create instances.The default option is the current Amazon Linux version.
" - }, - "HostnameTheme":{ - "shape":"String", - "documentation":"The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
" - }, - "ConfigurationManager":{ - "shape":"StackConfigurationManager", - "documentation":"The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.
" - }, - "ChefConfiguration":{ - "shape":"ChefConfiguration", - "documentation":"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Whether the stack uses custom cookbooks.
" - }, - "UseOpsworksSecurityGroups":{ - "shape":"Boolean", - "documentation":"Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
" - }, - "CustomCookbooksSource":{"shape":"Source"}, - "DefaultSshKeyName":{ - "shape":"String", - "documentation":"A default SSH key for the stack instances. You can override this value when you create or update an instance.
" - }, - "DefaultRootDeviceType":{ - "shape":"RootDeviceType", - "documentation":"The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.
Contains the response to a CreateStack request.
The user's IAM ARN.
" - }, - "SshUsername":{ - "shape":"String", - "documentation":"The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
The user's public SSH key.
" - }, - "AllowSelfManagement":{ - "shape":"Boolean", - "documentation":"Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.
" - } - } - }, - "CreateUserProfileResult":{ - "type":"structure", - "members":{ - "IamUserArn":{ - "shape":"String", - "documentation":"The user's IAM ARN.
" - } - }, - "documentation":"Contains the response to a CreateUserProfile request.
The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
The data source's ARN.
" - }, - "DatabaseName":{ - "shape":"String", - "documentation":"The database name.
" - } - }, - "documentation":"Describes an app's data source.
" - }, - "DataSources":{ - "type":"list", - "member":{"shape":"DataSource"} - }, - "DateTime":{"type":"string"}, - "DeleteAppRequest":{ - "type":"structure", - "required":["AppId"], - "members":{ - "AppId":{ - "shape":"String", - "documentation":"The app ID.
" - } - } - }, - "DeleteInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "DeleteElasticIp":{ - "shape":"Boolean", - "documentation":"Whether to delete the instance Elastic IP address.
" - }, - "DeleteVolumes":{ - "shape":"Boolean", - "documentation":"Whether to delete the instance's Amazon EBS volumes.
" - } - } - }, - "DeleteLayerRequest":{ - "type":"structure", - "required":["LayerId"], - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - } - } - }, - "DeleteStackRequest":{ - "type":"structure", - "required":["StackId"], - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - } - } - }, - "DeleteUserProfileRequest":{ - "type":"structure", - "required":["IamUserArn"], - "members":{ - "IamUserArn":{ - "shape":"String", - "documentation":"The user's IAM ARN.
" - } - } - }, - "Deployment":{ - "type":"structure", - "members":{ - "DeploymentId":{ - "shape":"String", - "documentation":"The deployment ID.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "AppId":{ - "shape":"String", - "documentation":"The app ID.
" - }, - "CreatedAt":{ - "shape":"DateTime", - "documentation":"Date when the deployment was created.
" - }, - "CompletedAt":{ - "shape":"DateTime", - "documentation":"Date when the deployment completed.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The deployment duration.
" - }, - "IamUserArn":{ - "shape":"String", - "documentation":"The user's IAM ARN.
" - }, - "Comment":{ - "shape":"String", - "documentation":"A user-defined comment.
" - }, - "Command":{"shape":"DeploymentCommand"}, - "Status":{ - "shape":"String", - "documentation":"The deployment status:
A string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for stack. The string should be in the following format and must escape characters such as '\"'.:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
" - }, - "InstanceIds":{ - "shape":"Strings", - "documentation":"The IDs of the target instances.
" - } - }, - "documentation":"Describes a deployment of a stack or app.
" - }, - "DeploymentCommand":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"DeploymentCommandName", - "documentation":"Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {\"recipes\":[\"phpapp::appsetup\"]}.install_dependencies: Install the stack's dependencies.update_custom_cookbooks: Update the stack's custom cookbooks.update_dependencies: Update the stack's dependencies.For apps, the following commands are available:
deploy: Deploy an app. Rails apps have an optional Args parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to migrate the database. The default setting is {\"migrate\":[\"false\"]}.rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.start: Start the app's web or application server.stop: Stop the app's web or application server.restart: Restart the app's web or application server.undeploy: Undeploy the app.The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...], ...}
The update_dependencies command takes two arguments:
upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2014.09. You must also set the allow_reboot argument to true.allow_reboot - Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.For example, to upgrade an instance to Amazon Linux 2014.09, set Args to the following.
{ \"upgrade_os_to\":[\"Amazon Linux 2014.09\"], \"allow_reboot\":[\"true\"] } "
- }
- },
- "documentation":"Used to specify a stack or deployment command.
" - }, - "DeploymentCommandArgs":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"Strings"} - }, - "DeploymentCommandName":{ - "type":"string", - "enum":[ - "install_dependencies", - "update_dependencies", - "update_custom_cookbooks", - "execute_recipes", - "deploy", - "rollback", - "start", - "stop", - "restart", - "undeploy" - ] - }, - "Deployments":{ - "type":"list", - "member":{"shape":"Deployment"} - }, - "DeregisterElasticIpRequest":{ - "type":"structure", - "required":["ElasticIp"], - "members":{ - "ElasticIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
" - } - } - }, - "DeregisterInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "DeregisterRdsDbInstanceRequest":{ - "type":"structure", - "required":["RdsDbInstanceArn"], - "members":{ - "RdsDbInstanceArn":{ - "shape":"String", - "documentation":"The Amazon RDS instance's ARN.
" - } - } - }, - "DeregisterVolumeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
" - } - } - }, - "DescribeAppsRequest":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.
An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.
An array of App objects that describe the specified apps.
Contains the response to a DescribeApps request.
The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.
The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.
An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.
An array of Command objects that describe each of the specified commands.
Contains the response to a DescribeCommands request.
The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.
The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.
An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.
An array of Deployment objects that describe the deployments.
Contains the response to a DescribeDeployments request.
The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.
A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.
An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.
An ElasticIps object that describes the specified Elastic IP addresses.
Contains the response to a DescribeElasticIps request.
A stack ID. The action describes the stack's Elastic Load Balancing instances.
" - }, - "LayerIds":{ - "shape":"Strings", - "documentation":"A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
" - } - } - }, - "DescribeElasticLoadBalancersResult":{ - "type":"structure", - "members":{ - "ElasticLoadBalancers":{ - "shape":"ElasticLoadBalancers", - "documentation":"A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
Contains the response to a DescribeElasticLoadBalancers request.
A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.
A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.
An array of Instance objects that describe the instances.
Contains the response to a DescribeInstances request.
The stack ID.
" - }, - "LayerIds":{ - "shape":"Strings", - "documentation":"An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.
An array of Layer objects that describe the layers.
Contains the response to a DescribeLayers request.
An array of layer IDs.
" - } - } - }, - "DescribeLoadBasedAutoScalingResult":{ - "type":"structure", - "members":{ - "LoadBasedAutoScalingConfigurations":{ - "shape":"LoadBasedAutoScalingConfigurations", - "documentation":"An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
Contains the response to a DescribeLoadBasedAutoScaling request.
A UserProfile object that describes the user's SSH information.
Contains the response to a DescribeMyUserProfile request.
The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - } - } - }, - "DescribePermissionsResult":{ - "type":"structure", - "members":{ - "Permissions":{ - "shape":"Permissions", - "documentation":"An array of Permission objects that describe the stack permissions.
Permission object with permissions for each of the stack IAM ARNs.Permission object with permissions for each of the user's stack IDs.Permission object with permissions for the specified stack and IAM ARN.Contains the response to a DescribePermissions request.
The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.
The stack ID.
" - }, - "RaidArrayIds":{ - "shape":"Strings", - "documentation":"An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.
A RaidArrays object that describes the specified RAID arrays.
Contains the response to a DescribeRaidArrays request.
The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.
" - }, - "RdsDbInstanceArns":{ - "shape":"Strings", - "documentation":"An array containing the ARNs of the instances to be described.
" - } - } - }, - "DescribeRdsDbInstancesResult":{ - "type":"structure", - "members":{ - "RdsDbInstances":{ - "shape":"RdsDbInstances", - "documentation":"An a array of RdsDbInstance objects that describe the instances.
Contains the response to a DescribeRdsDbInstances request.
The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.
The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.
An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.
An array of ServiceError objects that describe the specified service errors.
Contains the response to a DescribeServiceErrors request.
The stack ID
" - } - } - }, - "DescribeStackProvisioningParametersResult":{ - "type":"structure", - "members":{ - "AgentInstallerUrl":{ - "shape":"String", - "documentation":"The AWS OpsWorks agent installer's URL.
" - }, - "Parameters":{ - "shape":"Parameters", - "documentation":"An embedded object that contains the provisioning parameters.
" - } - }, - "documentation":"Contains the response to a DescribeStackProvisioningParameters request.
The stack ID.
" - } - } - }, - "DescribeStackSummaryResult":{ - "type":"structure", - "members":{ - "StackSummary":{ - "shape":"StackSummary", - "documentation":"A StackSummary object that contains the results.
Contains the response to a DescribeStackSummary request.
An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.
An array of Stack objects that describe the stacks.
Contains the response to a DescribeStacks request.
An array of instance IDs.
" - } - } - }, - "DescribeTimeBasedAutoScalingResult":{ - "type":"structure", - "members":{ - "TimeBasedAutoScalingConfigurations":{ - "shape":"TimeBasedAutoScalingConfigurations", - "documentation":"An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.
Contains the response to a DescribeTimeBasedAutoScaling request.
An array of IAM user ARNs that identify the users to be described.
" - } - } - }, - "DescribeUserProfilesResult":{ - "type":"structure", - "members":{ - "UserProfiles":{ - "shape":"UserProfiles", - "documentation":"A Users object that describes the specified users.
Contains the response to a DescribeUserProfiles request.
The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
A stack ID. The action describes the stack's registered Amazon EBS volumes.
" - }, - "RaidArrayId":{ - "shape":"String", - "documentation":"The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.
An array of volume IDs.
" - } - }, - "documentation":"Contains the response to a DescribeVolumes request.
The Elastic Load Balancing instance's name.
" - }, - "LayerId":{ - "shape":"String", - "documentation":"The ID of the layer that the Elastic Load Balancing instance is attached to.
" - } - } - }, - "DisassociateElasticIpRequest":{ - "type":"structure", - "required":["ElasticIp"], - "members":{ - "ElasticIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
" - } - } - }, - "Double":{ - "type":"double", - "box":true - }, - "ElasticIp":{ - "type":"structure", - "members":{ - "Ip":{ - "shape":"String", - "documentation":"The IP address.
" - }, - "Name":{ - "shape":"String", - "documentation":"The name.
" - }, - "Domain":{ - "shape":"String", - "documentation":"The domain.
" - }, - "Region":{ - "shape":"String", - "documentation":"The AWS region. For more information, see Regions and Endpoints.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance that the address is attached to.
" - } - }, - "documentation":"Describes an Elastic IP address.
" - }, - "ElasticIps":{ - "type":"list", - "member":{"shape":"ElasticIp"} - }, - "ElasticLoadBalancer":{ - "type":"structure", - "members":{ - "ElasticLoadBalancerName":{ - "shape":"String", - "documentation":"The Elastic Load Balancing instance's name.
" - }, - "Region":{ - "shape":"String", - "documentation":"The instance's AWS region.
" - }, - "DnsName":{ - "shape":"String", - "documentation":"The instance's public DNS name.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The ID of the stack that the instance is associated with.
" - }, - "LayerId":{ - "shape":"String", - "documentation":"The ID of the layer that the instance is attached to.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The VPC ID.
" - }, - "AvailabilityZones":{ - "shape":"Strings", - "documentation":"A list of Availability Zones.
" - }, - "SubnetIds":{ - "shape":"Strings", - "documentation":"A list of subnet IDs, if the stack is running in a VPC.
" - }, - "Ec2InstanceIds":{ - "shape":"Strings", - "documentation":"A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
" - } - }, - "documentation":"Describes an Elastic Load Balancing instance.
" - }, - "ElasticLoadBalancers":{ - "type":"list", - "member":{"shape":"ElasticLoadBalancer"} - }, - "EnvironmentVariable":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"String", - "documentation":"(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
" - }, - "Value":{ - "shape":"String", - "documentation":"(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.
" - }, - "Secure":{ - "shape":"Boolean", - "documentation":"(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns **Filtered** instead of the actual value. The default value for Secure is false.
Represents an app's environment variable.
" - }, - "EnvironmentVariables":{ - "type":"list", - "member":{"shape":"EnvironmentVariable"} - }, - "GetHostnameSuggestionRequest":{ - "type":"structure", - "required":["LayerId"], - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - } - } - }, - "GetHostnameSuggestionResult":{ - "type":"structure", - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - }, - "Hostname":{ - "shape":"String", - "documentation":"The generated host name.
" - } - }, - "documentation":"Contains the response to a GetHostnameSuggestion request.
The instance ID.
" - }, - "Ec2InstanceId":{ - "shape":"String", - "documentation":"The ID of the associated Amazon EC2 instance.
" - }, - "VirtualizationType":{ - "shape":"VirtualizationType", - "documentation":"The instance's virtualization type, paravirtual or hvm.
The instance host name.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "LayerIds":{ - "shape":"Strings", - "documentation":"An array containing the instance layer IDs.
" - }, - "SecurityGroupIds":{ - "shape":"Strings", - "documentation":"An array containing the instance security group IDs.
" - }, - "InstanceType":{ - "shape":"String", - "documentation":"The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that specify the various types are in the API Name column of the Available Instance Types table.
" - }, - "InstanceProfileArn":{ - "shape":"String", - "documentation":"The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
" - }, - "Status":{ - "shape":"String", - "documentation":"The instance status:
bootingconnection_lostonlinependingrebootingrequestedrunning_setupsetup_failedshutting_downstart_failedstoppedstoppingterminatedterminatingThe instance's operating system.
" - }, - "AmiId":{ - "shape":"String", - "documentation":"A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The instance Availability Zone. For more information, see Regions and Endpoints.
" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The instance's subnet ID, if the stack is running in a VPC.
" - }, - "PublicDns":{ - "shape":"String", - "documentation":"The instance public DNS name.
" - }, - "PrivateDns":{ - "shape":"String", - "documentation":"The instance private DNS name.
" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The instance public IP address.
" - }, - "PrivateIp":{ - "shape":"String", - "documentation":"The instance private IP address.
" - }, - "ElasticIp":{ - "shape":"String", - "documentation":"The instance Elastic IP address .
" - }, - "AutoScalingType":{ - "shape":"AutoScalingType", - "documentation":"For load-based or time-based instances, the type.
" - }, - "SshKeyName":{ - "shape":"String", - "documentation":"The instance SSH key name.
" - }, - "SshHostRsaKeyFingerprint":{ - "shape":"String", - "documentation":"The SSH key's RSA fingerprint.
" - }, - "SshHostDsaKeyFingerprint":{ - "shape":"String", - "documentation":"The SSH key's DSA fingerprint.
" - }, - "CreatedAt":{ - "shape":"DateTime", - "documentation":"The time that the instance was created.
" - }, - "LastServiceErrorId":{ - "shape":"String", - "documentation":"The ID of the last service error. For more information, call DescribeServiceErrors.
" - }, - "Architecture":{ - "shape":"Architecture", - "documentation":"The instance architecture, \"i386\" or \"x86_64\".
" - }, - "RootDeviceType":{ - "shape":"RootDeviceType", - "documentation":"The instance root device type. For more information, see Storage for the Root Device.
" - }, - "RootDeviceVolumeId":{ - "shape":"String", - "documentation":"The root device volume ID.
" - }, - "InstallUpdatesOnBoot":{ - "shape":"Boolean", - "documentation":"Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether this is an Amazon EBS-optimized instance.
" - }, - "ReportedOs":{ - "shape":"ReportedOs", - "documentation":"For registered instances, the reported operating system.
" - }, - "InfrastructureClass":{ - "shape":"String", - "documentation":"For registered instances, the infrastructure class: ec2 or on-premises
For registered instances, who performed the registration.
" - } - }, - "documentation":"Describes an instance.
" - }, - "InstanceIdentity":{ - "type":"structure", - "members":{ - "Document":{ - "shape":"String", - "documentation":"A JSON document that contains the metadata.
" - }, - "Signature":{ - "shape":"String", - "documentation":"A signature that can be used to verify the document's accuracy and authenticity.
" - } - }, - "documentation":"Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.
" - }, - "Instances":{ - "type":"list", - "member":{"shape":"Instance"} - }, - "InstancesCount":{ - "type":"structure", - "members":{ - "Assigning":{ - "shape":"Integer", - "documentation":"The number of instances in the Assigning state.
" - }, - "Booting":{ - "shape":"Integer", - "documentation":"The number of instances with booting status.
The number of instances with connection_lost status.
The number of instances in the Deregistering state.
" - }, - "Online":{ - "shape":"Integer", - "documentation":"The number of instances with online status.
The number of instances with pending status.
The number of instances with rebooting status.
The number of instances in the Registered state.
" - }, - "Registering":{ - "shape":"Integer", - "documentation":"The number of instances in the Registering state.
" - }, - "Requested":{ - "shape":"Integer", - "documentation":"The number of instances with requested status.
The number of instances with running_setup status.
The number of instances with setup_failed status.
The number of instances with shutting_down status.
The number of instances with start_failed status.
The number of instances with stopped status.
The number of instances with stopping status.
The number of instances with terminated status.
The number of instances with terminating status.
The number of instances in the Unassigning state.
" - } - }, - "documentation":"Describes how many instances a stack has for each status.
" - }, - "Integer":{ - "type":"integer", - "box":true - }, - "Layer":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The layer stack ID.
" - }, - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - }, - "Type":{ - "shape":"LayerType", - "documentation":"The layer type.
" - }, - "Name":{ - "shape":"String", - "documentation":"The layer name.
" - }, - "Shortname":{ - "shape":"String", - "documentation":"The layer short name.
" - }, - "Attributes":{ - "shape":"LayerAttributes", - "documentation":"The layer attributes.
" - }, - "CustomInstanceProfileArn":{ - "shape":"String", - "documentation":"The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "CustomSecurityGroupIds":{ - "shape":"Strings", - "documentation":"An array containing the layer's custom security group IDs.
" - }, - "DefaultSecurityGroupNames":{ - "shape":"Strings", - "documentation":"An array containing the layer's security group names.
" - }, - "Packages":{ - "shape":"Strings", - "documentation":"An array of Package objects that describe the layer's packages.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether auto healing is disabled for the layer.
" - }, - "AutoAssignElasticIps":{ - "shape":"Boolean", - "documentation":"Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
" - }, - "AutoAssignPublicIps":{ - "shape":"Boolean", - "documentation":"For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
" - }, - "DefaultRecipes":{"shape":"Recipes"}, - "CustomRecipes":{ - "shape":"Recipes", - "documentation":"A LayerCustomRecipes object that specifies the layer's custom recipes.
Date when the layer was created.
" - }, - "InstallUpdatesOnBoot":{ - "shape":"Boolean", - "documentation":"Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether the layer uses Amazon EBS-optimized instances.
" - }, - "LifecycleEventConfiguration":{ - "shape":"LifecycleEventConfiguration", - "documentation":"A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
Describes a layer.
" - }, - "LayerAttributes":{ - "type":"map", - "key":{"shape":"LayerAttributesKeys"}, - "value":{"shape":"String"} - }, - "LayerAttributesKeys":{ - "type":"string", - "enum":[ - "EnableHaproxyStats", - "HaproxyStatsUrl", - "HaproxyStatsUser", - "HaproxyStatsPassword", - "HaproxyHealthCheckUrl", - "HaproxyHealthCheckMethod", - "MysqlRootPassword", - "MysqlRootPasswordUbiquitous", - "GangliaUrl", - "GangliaUser", - "GangliaPassword", - "MemcachedMemory", - "NodejsVersion", - "RubyVersion", - "RubygemsVersion", - "ManageBundler", - "BundlerVersion", - "RailsStack", - "PassengerVersion", - "Jvm", - "JvmVersion", - "JvmOptions", - "JavaAppServer", - "JavaAppServerVersion" - ] - }, - "LayerType":{ - "type":"string", - "enum":[ - "java-app", - "lb", - "web", - "php-app", - "rails-app", - "nodejs-app", - "memcached", - "db-master", - "monitoring-master", - "custom" - ] - }, - "Layers":{ - "type":"list", - "member":{"shape":"Layer"} - }, - "LifecycleEventConfiguration":{ - "type":"structure", - "members":{ - "Shutdown":{ - "shape":"ShutdownEventConfiguration", - "documentation":"A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
Specifies the lifecycle event configuration
" - }, - "LoadBasedAutoScalingConfiguration":{ - "type":"structure", - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - }, - "Enable":{ - "shape":"Boolean", - "documentation":"Whether load-based auto scaling is enabled for the layer.
" - }, - "UpScaling":{ - "shape":"AutoScalingThresholds", - "documentation":"An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.
An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.
Describes a layer's load-based auto scaling configuration.
" - }, - "LoadBasedAutoScalingConfigurations":{ - "type":"list", - "member":{"shape":"LoadBasedAutoScalingConfiguration"} - }, - "Minute":{ - "type":"integer", - "min":1, - "max":100, - "box":true - }, - "Parameters":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "Permission":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"String", - "documentation":"A stack ID.
" - }, - "IamUserArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.
" - }, - "AllowSsh":{ - "shape":"Boolean", - "documentation":"Whether the user can use SSH.
" - }, - "AllowSudo":{ - "shape":"Boolean", - "documentation":"Whether the user can use sudo.
" - }, - "Level":{ - "shape":"String", - "documentation":"The user's permission level, which must be the following:
denyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see Managing User Permissions
" - } - }, - "documentation":"Describes stack or user permissions.
" - }, - "Permissions":{ - "type":"list", - "member":{"shape":"Permission"} - }, - "RaidArray":{ - "type":"structure", - "members":{ - "RaidArrayId":{ - "shape":"String", - "documentation":"The array ID.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The array name.
" - }, - "RaidLevel":{ - "shape":"Integer", - "documentation":"The RAID level.
" - }, - "NumberOfDisks":{ - "shape":"Integer", - "documentation":"The number of disks in the array.
" - }, - "Size":{ - "shape":"Integer", - "documentation":"The array's size.
" - }, - "Device":{ - "shape":"String", - "documentation":"The array's Linux device. For example /dev/mdadm0.
" - }, - "MountPoint":{ - "shape":"String", - "documentation":"The array's mount point.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The array's Availability Zone. For more information, see Regions and Endpoints.
" - }, - "CreatedAt":{ - "shape":"DateTime", - "documentation":"When the RAID array was created.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "VolumeType":{ - "shape":"String", - "documentation":"The volume type, standard or PIOPS.
" - }, - "Iops":{ - "shape":"Integer", - "documentation":"For PIOPS volumes, the IOPS per disk.
" - } - }, - "documentation":"Describes an instance's RAID array.
" - }, - "RaidArrays":{ - "type":"list", - "member":{"shape":"RaidArray"} - }, - "RdsDbInstance":{ - "type":"structure", - "members":{ - "RdsDbInstanceArn":{ - "shape":"String", - "documentation":"The instance's ARN.
" - }, - "DbInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier.
" - }, - "DbUser":{ - "shape":"String", - "documentation":"The master user name.
" - }, - "DbPassword":{ - "shape":"String", - "documentation":"The database password.
" - }, - "Region":{ - "shape":"String", - "documentation":"The instance's AWS region.
" - }, - "Address":{ - "shape":"String", - "documentation":"The instance's address.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The instance's database engine.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The ID of the stack that the instance is registered with.
" - }, - "MissingOnRds":{ - "shape":"Boolean", - "documentation":"Set to true if AWS OpsWorks was unable to discover the Amazon RDS instance. AWS OpsWorks attempts to discover the instance only once. If this value is set to true, you must deregister the instance and then register it again.
Describes an Amazon RDS instance.
" - }, - "RdsDbInstances":{ - "type":"list", - "member":{"shape":"RdsDbInstance"} - }, - "RebootInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "Recipes":{ - "type":"structure", - "members":{ - "Setup":{ - "shape":"Strings", - "documentation":"An array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
AWS OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.
" - }, - "RegisterElasticIpRequest":{ - "type":"structure", - "required":[ - "ElasticIp", - "StackId" - ], - "members":{ - "ElasticIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - } - } - }, - "RegisterElasticIpResult":{ - "type":"structure", - "members":{ - "ElasticIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
" - } - }, - "documentation":"Contains the response to a RegisterElasticIp request.
The ID of the stack that the instance is to be registered with.
" - }, - "Hostname":{ - "shape":"String", - "documentation":"The instance's hostname.
" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The instance's public IP address.
" - }, - "PrivateIp":{ - "shape":"String", - "documentation":"The instance's private IP address.
" - }, - "RsaPublicKey":{ - "shape":"String", - "documentation":"The instances public RSA key. This key is used to encrypt communication between the instance and the service.
" - }, - "RsaPublicKeyFingerprint":{ - "shape":"String", - "documentation":"The instances public RSA key fingerprint.
" - }, - "InstanceIdentity":{ - "shape":"InstanceIdentity", - "documentation":"An InstanceIdentity object that contains the instance's identity.
" - } - } - }, - "RegisterInstanceResult":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The registered instance's AWS OpsWorks ID.
" - } - }, - "documentation":"Contains the response to a RegisterInstanceResult request.
The stack ID.
" - }, - "RdsDbInstanceArn":{ - "shape":"String", - "documentation":"The Amazon RDS instance's ARN.
" - }, - "DbUser":{ - "shape":"String", - "documentation":"The database's master user name.
" - }, - "DbPassword":{ - "shape":"String", - "documentation":"The database password.
" - } - } - }, - "RegisterVolumeRequest":{ - "type":"structure", - "required":["StackId"], - "members":{ - "Ec2VolumeId":{ - "shape":"String", - "documentation":"The Amazon EBS volume ID.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - } - } - }, - "RegisterVolumeResult":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
" - } - }, - "documentation":"Contains the response to a RegisterVolume request.
The operating system family.
" - }, - "Name":{ - "shape":"String", - "documentation":"The operating system name.
" - }, - "Version":{ - "shape":"String", - "documentation":"The operating system version.
" - } - }, - "documentation":"A registered instance's reported operating system.
" - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The exception message.
" - } - }, - "exception":true, - "documentation":"Indicates that a resource was not found.
" - }, - "RootDeviceType":{ - "type":"string", - "enum":[ - "ebs", - "instance-store" - ] - }, - "SelfUserProfile":{ - "type":"structure", - "members":{ - "IamUserArn":{ - "shape":"String", - "documentation":"The user's IAM ARN.
" - }, - "Name":{ - "shape":"String", - "documentation":"The user's name.
" - }, - "SshUsername":{ - "shape":"String", - "documentation":"The user's SSH user name.
" - }, - "SshPublicKey":{ - "shape":"String", - "documentation":"The user's SSH public key.
" - } - }, - "documentation":"Describes a user's SSH information.
" - }, - "ServiceError":{ - "type":"structure", - "members":{ - "ServiceErrorId":{ - "shape":"String", - "documentation":"The error ID.
" - }, - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "Type":{ - "shape":"String", - "documentation":"The error type.
" - }, - "Message":{ - "shape":"String", - "documentation":"A message that describes the error.
" - }, - "CreatedAt":{ - "shape":"DateTime", - "documentation":"When the error occurred.
" - } - }, - "documentation":"Describes an AWS OpsWorks service error.
" - }, - "ServiceErrors":{ - "type":"list", - "member":{"shape":"ServiceError"} - }, - "SetLoadBasedAutoScalingRequest":{ - "type":"structure", - "required":["LayerId"], - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - }, - "Enable":{ - "shape":"Boolean", - "documentation":"Enables load-based auto scaling for the layer.
" - }, - "UpScaling":{ - "shape":"AutoScalingThresholds", - "documentation":"An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.
An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.
The stack ID.
" - }, - "IamUserArn":{ - "shape":"String", - "documentation":"The user's IAM ARN.
" - }, - "AllowSsh":{ - "shape":"Boolean", - "documentation":"The user is allowed to use SSH to communicate with the instance.
" - }, - "AllowSudo":{ - "shape":"Boolean", - "documentation":"The user is allowed to use sudo to elevate privileges.
" - }, - "Level":{ - "shape":"String", - "documentation":"The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
denyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see Managing User Permissions
" - } - } - }, - "SetTimeBasedAutoScalingRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "AutoScalingSchedule":{ - "shape":"WeeklyAutoScalingSchedule", - "documentation":"An AutoScalingSchedule with the instance schedule.
The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
" - }, - "DelayUntilElbConnectionsDrained":{ - "shape":"Boolean", - "documentation":"Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
" - } - }, - "documentation":"The Shutdown event configuration.
" - }, - "Source":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"SourceType", - "documentation":"The repository type.
" - }, - "Url":{ - "shape":"String", - "documentation":"The source URL.
" - }, - "Username":{ - "shape":"String", - "documentation":"This parameter depends on the repository type.
Username to the appropriate IAM access key ID.Username to the user name.This parameter depends on the repository type.
Password to the appropriate IAM secret access key.Password to the password.For more information on how to safely handle IAM credentials, see .
" - }, - "SshKey":{ - "shape":"String", - "documentation":"The repository's SSH key.
" - }, - "Revision":{ - "shape":"String", - "documentation":"The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
" - } - }, - "documentation":"Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
" - }, - "SourceType":{ - "type":"string", - "enum":[ - "git", - "svn", - "archive", - "s3" - ] - }, - "SslConfiguration":{ - "type":"structure", - "required":[ - "Certificate", - "PrivateKey" - ], - "members":{ - "Certificate":{ - "shape":"String", - "documentation":"The contents of the certificate's domain.crt file.
" - }, - "PrivateKey":{ - "shape":"String", - "documentation":"The private key; the contents of the certificate's domain.kex file.
" - }, - "Chain":{ - "shape":"String", - "documentation":"Optional. Can be used to specify an intermediate certificate authority key or client authentication.
" - } - }, - "documentation":"Describes an app's SSL configuration.
" - }, - "Stack":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The stack name.
" - }, - "Arn":{ - "shape":"String", - "documentation":"The stack's ARN.
" - }, - "Region":{ - "shape":"String", - "documentation":"The stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The VPC ID, if the stack is running in a VPC.
" - }, - "Attributes":{ - "shape":"StackAttributes", - "documentation":"The stack's attributes.
" - }, - "ServiceRoleArn":{ - "shape":"String", - "documentation":"The stack AWS Identity and Access Management (IAM) role.
" - }, - "DefaultInstanceProfileArn":{ - "shape":"String", - "documentation":"The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "DefaultOs":{ - "shape":"String", - "documentation":"The stack's default operating system.
" - }, - "HostnameTheme":{ - "shape":"String", - "documentation":"The stack host name theme, with spaces replaced by underscores.
" - }, - "DefaultAvailabilityZone":{ - "shape":"String", - "documentation":"The stack's default Availability Zone. For more information, see Regions and Endpoints.
" - }, - "DefaultSubnetId":{ - "shape":"String", - "documentation":"The default subnet ID, if the stack is running in a VPC.
" - }, - "CustomJson":{ - "shape":"String", - "documentation":"A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
" - }, - "ConfigurationManager":{ - "shape":"StackConfigurationManager", - "documentation":"The configuration manager.
" - }, - "ChefConfiguration":{ - "shape":"ChefConfiguration", - "documentation":"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
Whether the stack uses custom cookbooks.
" - }, - "UseOpsworksSecurityGroups":{ - "shape":"Boolean", - "documentation":"Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
" - }, - "CustomCookbooksSource":{"shape":"Source"}, - "DefaultSshKeyName":{ - "shape":"String", - "documentation":"A default SSH key for the stack's instances. You can override this value when you create or update an instance.
" - }, - "CreatedAt":{ - "shape":"DateTime", - "documentation":"Date when the stack was created.
" - }, - "DefaultRootDeviceType":{ - "shape":"RootDeviceType", - "documentation":"The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
" - } - }, - "documentation":"Describes a stack.
" - }, - "StackAttributes":{ - "type":"map", - "key":{"shape":"StackAttributesKeys"}, - "value":{"shape":"String"} - }, - "StackAttributesKeys":{ - "type":"string", - "enum":["Color"] - }, - "StackConfigurationManager":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name. This parameter must be set to \"Chef\".
" - }, - "Version":{ - "shape":"String", - "documentation":"The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
" - } - }, - "documentation":"Describes the configuration manager.
" - }, - "StackSummary":{ - "type":"structure", - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The stack name.
" - }, - "Arn":{ - "shape":"String", - "documentation":"The stack's ARN.
" - }, - "LayersCount":{ - "shape":"Integer", - "documentation":"The number of layers.
" - }, - "AppsCount":{ - "shape":"Integer", - "documentation":"The number of apps.
" - }, - "InstancesCount":{ - "shape":"InstancesCount", - "documentation":"An InstancesCount object with the number of instances in each status.
Summarizes the number of layers, instances, and apps in a stack.
" - }, - "Stacks":{ - "type":"list", - "member":{"shape":"Stack"} - }, - "StartInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "StartStackRequest":{ - "type":"structure", - "required":["StackId"], - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - } - } - }, - "StopInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "StopStackRequest":{ - "type":"structure", - "required":["StackId"], - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - } - } - }, - "String":{"type":"string"}, - "Strings":{ - "type":"list", - "member":{"shape":"String"} - }, - "Switch":{"type":"string"}, - "TimeBasedAutoScalingConfiguration":{ - "type":"structure", - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "AutoScalingSchedule":{ - "shape":"WeeklyAutoScalingSchedule", - "documentation":"A WeeklyAutoScalingSchedule object with the instance schedule.
Describes an instance's time-based auto scaling configuration.
" - }, - "TimeBasedAutoScalingConfigurations":{ - "type":"list", - "member":{"shape":"TimeBasedAutoScalingConfiguration"} - }, - "UnassignInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - } - } - }, - "UnassignVolumeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
" - } - } - }, - "UpdateAppRequest":{ - "type":"structure", - "required":["AppId"], - "members":{ - "AppId":{ - "shape":"String", - "documentation":"The app ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The app name.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the app.
" - }, - "DataSources":{ - "shape":"DataSources", - "documentation":"The app's data sources.
" - }, - "Type":{ - "shape":"AppType", - "documentation":"The app type.
" - }, - "AppSource":{ - "shape":"Source", - "documentation":"A Source object that specifies the app repository.
The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
Whether SSL is enabled for the app.
" - }, - "SslConfiguration":{ - "shape":"SslConfiguration", - "documentation":"An SslConfiguration object with the SSL configuration.
One or more user-defined key/value pairs to be added to the stack attributes.
" - }, - "Environment":{ - "shape":"EnvironmentVariables", - "documentation":"An array of EnvironmentVariable objects that specify environment variables to be associated with the app. You can specify up to ten environment variables. After you deploy the app, these variables are defined on the associated app server instances.
The address.
" - }, - "Name":{ - "shape":"String", - "documentation":"The new name.
" - } - } - }, - "UpdateInstanceRequest":{ - "type":"structure", - "required":["InstanceId"], - "members":{ - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "LayerIds":{ - "shape":"Strings", - "documentation":"The instance's layer IDs.
" - }, - "InstanceType":{ - "shape":"String", - "documentation":"The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
" - }, - "AutoScalingType":{ - "shape":"AutoScalingType", - "documentation":"For load-based or time-based instances, the type.
" - }, - "Hostname":{ - "shape":"String", - "documentation":"The instance host name.
" - }, - "Os":{ - "shape":"String", - "documentation":"The instance's operating system, which must be set to one of the following.
Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.Custom The default option is the current Amazon Linux version, such as Amazon Linux 2014.09. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances
Os to Custom.The instance SSH key name.
" - }, - "Architecture":{ - "shape":"Architecture", - "documentation":"The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
" - }, - "InstallUpdatesOnBoot":{ - "shape":"Boolean", - "documentation":"Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether this is an Amazon EBS-optimized instance.
" - } - } - }, - "UpdateLayerRequest":{ - "type":"structure", - "required":["LayerId"], - "members":{ - "LayerId":{ - "shape":"String", - "documentation":"The layer ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The layer name, which is used by the console.
" - }, - "Shortname":{ - "shape":"String", - "documentation":"The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.
" - }, - "Attributes":{ - "shape":"LayerAttributes", - "documentation":"One or more user-defined key/value pairs to be added to the stack attributes.
" - }, - "CustomInstanceProfileArn":{ - "shape":"String", - "documentation":"The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "CustomSecurityGroupIds":{ - "shape":"Strings", - "documentation":"An array containing the layer's custom security group IDs.
" - }, - "Packages":{ - "shape":"Strings", - "documentation":"An array of Package objects that describe the layer's packages.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Whether to disable auto healing for the layer.
" - }, - "AutoAssignElasticIps":{ - "shape":"Boolean", - "documentation":"Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
" - }, - "AutoAssignPublicIps":{ - "shape":"Boolean", - "documentation":"For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
" - }, - "CustomRecipes":{ - "shape":"Recipes", - "documentation":"A LayerCustomRecipes object that specifies the layer's custom recipes.
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether to use Amazon EBS-optimized instances.
" - }, - "LifecycleEventConfiguration":{ - "shape":"LifecycleEventConfiguration", - "documentation":"" - } - } - }, - "UpdateMyUserProfileRequest":{ - "type":"structure", - "members":{ - "SshPublicKey":{ - "shape":"String", - "documentation":"The user's SSH public key.
" - } - } - }, - "UpdateRdsDbInstanceRequest":{ - "type":"structure", - "required":["RdsDbInstanceArn"], - "members":{ - "RdsDbInstanceArn":{ - "shape":"String", - "documentation":"The Amazon RDS instance's ARN.
" - }, - "DbUser":{ - "shape":"String", - "documentation":"The master user name.
" - }, - "DbPassword":{ - "shape":"String", - "documentation":"The database password.
" - } - } - }, - "UpdateStackRequest":{ - "type":"structure", - "required":["StackId"], - "members":{ - "StackId":{ - "shape":"String", - "documentation":"The stack ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The stack's new name.
" - }, - "Attributes":{ - "shape":"StackAttributes", - "documentation":"One or more user-defined key/value pairs to be added to the stack attributes.
" - }, - "ServiceRoleArn":{ - "shape":"String", - "documentation":"The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.
The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
" - }, - "DefaultOs":{ - "shape":"String", - "documentation":"The stack's operating system, which must be set to one of the following.
Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.Custom. You specify the custom AMI you want to use when you create instances.The default option is the current Amazon Linux version.
" - }, - "HostnameTheme":{ - "shape":"String", - "documentation":"The stack's new host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"'.:
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
" - }, - "ConfigurationManager":{ - "shape":"StackConfigurationManager", - "documentation":"The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version, 0.9, 11.4, or 11.10. The default value is currently 11.4.
" - }, - "ChefConfiguration":{ - "shape":"ChefConfiguration", - "documentation":"A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Whether the stack uses custom cookbooks.
" - }, - "CustomCookbooksSource":{"shape":"Source"}, - "DefaultSshKeyName":{ - "shape":"String", - "documentation":"A default SSH key for the stack instances. You can override this value when you create or update an instance.
" - }, - "DefaultRootDeviceType":{ - "shape":"RootDeviceType", - "documentation":"The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
" - }, - "UseOpsworksSecurityGroups":{ - "shape":"Boolean", - "documentation":"Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
" - } - } - }, - "UpdateUserProfileRequest":{ - "type":"structure", - "required":["IamUserArn"], - "members":{ - "IamUserArn":{ - "shape":"String", - "documentation":"The user IAM ARN.
" - }, - "SshUsername":{ - "shape":"String", - "documentation":"The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
The user's new SSH public key.
" - }, - "AllowSelfManagement":{ - "shape":"Boolean", - "documentation":"Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
" - } - } - }, - "UpdateVolumeRequest":{ - "type":"structure", - "required":["VolumeId"], - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The new name.
" - }, - "MountPoint":{ - "shape":"String", - "documentation":"The new mount point.
" - } - } - }, - "UserProfile":{ - "type":"structure", - "members":{ - "IamUserArn":{ - "shape":"String", - "documentation":"The user's IAM ARN.
" - }, - "Name":{ - "shape":"String", - "documentation":"The user's name.
" - }, - "SshUsername":{ - "shape":"String", - "documentation":"The user's SSH user name.
" - }, - "SshPublicKey":{ - "shape":"String", - "documentation":"The user's SSH public key.
" - }, - "AllowSelfManagement":{ - "shape":"Boolean", - "documentation":"Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
" - } - }, - "documentation":"Describes a user's SSH information.
" - }, - "UserProfiles":{ - "type":"list", - "member":{"shape":"UserProfile"} - }, - "ValidationException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"The exception message.
" - } - }, - "exception":true, - "documentation":"Indicates that a request was invalid.
" - }, - "VirtualizationType":{ - "type":"string", - "enum":[ - "paravirtual", - "hvm" - ] - }, - "Volume":{ - "type":"structure", - "members":{ - "VolumeId":{ - "shape":"String", - "documentation":"The volume ID.
" - }, - "Ec2VolumeId":{ - "shape":"String", - "documentation":"The Amazon EC2 volume ID.
" - }, - "Name":{ - "shape":"String", - "documentation":"The volume name.
" - }, - "RaidArrayId":{ - "shape":"String", - "documentation":"The RAID array ID.
" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The instance ID.
" - }, - "Status":{ - "shape":"String", - "documentation":"The value returned by DescribeVolumes.
" - }, - "Size":{ - "shape":"Integer", - "documentation":"The volume size.
" - }, - "Device":{ - "shape":"String", - "documentation":"The device name.
" - }, - "MountPoint":{ - "shape":"String", - "documentation":"The volume mount point. For example \"/dev/sdh\".
" - }, - "Region":{ - "shape":"String", - "documentation":"The AWS region. For more information about AWS regions, see Regions and Endpoints.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The volume Availability Zone. For more information, see Regions and Endpoints.
" - }, - "VolumeType":{ - "shape":"String", - "documentation":"The volume type, standard or PIOPS.
" - }, - "Iops":{ - "shape":"Integer", - "documentation":"For PIOPS volumes, the IOPS per disk.
" - } - }, - "documentation":"Describes an instance's Amazon EBS volume.
" - }, - "VolumeConfiguration":{ - "type":"structure", - "required":[ - "MountPoint", - "NumberOfDisks", - "Size" - ], - "members":{ - "MountPoint":{ - "shape":"String", - "documentation":"The volume mount point. For example \"/dev/sdh\".
" - }, - "RaidLevel":{ - "shape":"Integer", - "documentation":"The volume RAID level.
" - }, - "NumberOfDisks":{ - "shape":"Integer", - "documentation":"The number of disks in the volume.
" - }, - "Size":{ - "shape":"Integer", - "documentation":"The volume size.
" - }, - "VolumeType":{ - "shape":"String", - "documentation":"The volume type:
standard - Magneticio1 - Provisioned IOPS (SSD)gp2 - General Purpose (SSD)For PIOPS volumes, the IOPS per disk.
" - } - }, - "documentation":"Describes an Amazon EBS volume configuration.
" - }, - "VolumeConfigurations":{ - "type":"list", - "member":{"shape":"VolumeConfiguration"} - }, - "Volumes":{ - "type":"list", - "member":{"shape":"Volume"} - }, - "WeeklyAutoScalingSchedule":{ - "type":"structure", - "members":{ - "Monday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Monday.
" - }, - "Tuesday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Tuesday.
" - }, - "Wednesday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Wednesday.
" - }, - "Thursday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Thursday.
" - }, - "Friday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Friday.
" - }, - "Saturday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Saturday.
" - }, - "Sunday":{ - "shape":"DailyAutoScalingSchedule", - "documentation":"The schedule for Sunday.
" - } - }, - "documentation":"Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.
The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.
The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.
{ \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" }
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.
", - "operations":{ - "AddSourceIdentifierToSubscription":{ - "name":"AddSourceIdentifierToSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddSourceIdentifierToSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"AddSourceIdentifierToSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"AddSourceIdentifierToSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - } - ], - "documentation":"Adds a source identifier to an existing RDS event notification subscription.
" - }, - "AddTagsToResource":{ - "name":"AddTagsToResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddTagsToResourceMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
" - }, - "AuthorizeDBSecurityGroupIngress":{ - "name":"AuthorizeDBSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AuthorizeDBSecurityGroupIngressMessage", - "documentation":"" - }, - "output":{ - "shape":"AuthorizeDBSecurityGroupIngressResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", - "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - }, - { - "shape":"AuthorizationAlreadyExistsFault", - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
" - }, - { - "shape":"AuthorizationQuotaExceededFault", - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB security group authorization quota has been reached.
" - } - ], - "documentation":"Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
" - }, - "CopyDBParameterGroup":{ - "name":"CopyDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyDBParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyDBParameterGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", - "resultWrapper":"CopyDBParameterGroupResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"DBParameterGroupAlreadyExistsFault", - "error":{ - "code":"DBParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB parameter group with the same name exists.
" - }, - { - "shape":"DBParameterGroupQuotaExceededFault", - "error":{ - "code":"DBParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
" - } - ], - "documentation":"Copies the specified DBParameterGroup.
" - }, - "CopyDBSnapshot":{ - "name":"CopyDBSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyDBSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", - "resultWrapper":"CopyDBSnapshotResult" - }, - "errors":[ - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - }, - { - "shape":"InvalidDBSnapshotStateFault", - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - } - ], - "documentation":"Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.
" - }, - "CopyOptionGroup":{ - "name":"CopyOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyOptionGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyOptionGroupResult", - "wrapper":true, - "documentation":"
", - "resultWrapper":"CopyOptionGroupResult" - }, - "errors":[ - { - "shape":"OptionGroupAlreadyExistsFault", - "error":{ - "code":"OptionGroupAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group you are trying to create already exists.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"OptionGroupQuotaExceededFault", - "error":{ - "code":"OptionGroupQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota of 20 option groups was exceeded for this AWS account.
" - } - ], - "documentation":"Copies the specified Option Group.
" - }, - "CreateDBInstance":{ - "name":"CreateDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"CreateDBInstanceResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - } - ], - "documentation":"Creates a new DB instance.
" - }, - "CreateDBInstanceReadReplica":{ - "name":"CreateDBInstanceReadReplica", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, - "output":{ - "shape":"CreateDBInstanceReadReplicaResult", - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"CreateDBInstanceReadReplicaResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"DBSubnetGroupNotAllowedFault", - "error":{ - "code":"DBSubnetGroupNotAllowedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
" - }, - { - "shape":"InvalidDBSubnetGroupFault", - "error":{ - "code":"InvalidDBSubnetGroupFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - } - ], - "documentation":"Creates a DB instance that acts as a read replica of a source DB instance.
All read replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
" - }, - "output":{ - "shape":"CreateDBParameterGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", - "resultWrapper":"CreateDBParameterGroupResult" - }, - "errors":[ - { - "shape":"DBParameterGroupQuotaExceededFault", - "error":{ - "code":"DBParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
" - }, - { - "shape":"DBParameterGroupAlreadyExistsFault", - "error":{ - "code":"DBParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB parameter group with the same name exists.
" - } - ], - "documentation":"Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
" - }, - "output":{ - "shape":"CreateDBSecurityGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", - "resultWrapper":"CreateDBSecurityGroupResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupAlreadyExistsFault", - "error":{ - "code":"DBSecurityGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group with the name specified in DBSecurityGroupName already exists.
" - }, - { - "shape":"DBSecurityGroupQuotaExceededFault", - "error":{ - "code":"QuotaExceeded.DBSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB security groups.
" - }, - { - "shape":"DBSecurityGroupNotSupportedFault", - "error":{ - "code":"DBSecurityGroupNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group is not allowed for this action.
" - } - ], - "documentation":"Creates a new DB security group. DB security groups control access to a DB instance.
" - }, - "CreateDBSnapshot":{ - "name":"CreateDBSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDBSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", - "resultWrapper":"CreateDBSnapshotResult" - }, - "errors":[ - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - } - ], - "documentation":"Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
" - }, - "CreateDBSubnetGroup":{ - "name":"CreateDBSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDBSubnetGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateDBSubnetGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", - "resultWrapper":"CreateDBSubnetGroupResult" - }, - "errors":[ - { - "shape":"DBSubnetGroupAlreadyExistsFault", - "error":{ - "code":"DBSubnetGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName is already used by an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupQuotaExceededFault", - "error":{ - "code":"DBSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB subnet groups.
" - }, - { - "shape":"DBSubnetQuotaExceededFault", - "error":{ - "code":"DBSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - } - ], - "documentation":"Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
" - }, - "CreateEventSubscription":{ - "name":"CreateEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateEventSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"CreateEventSubscriptionResult" - }, - "errors":[ - { - "shape":"EventSubscriptionQuotaExceededFault", - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You have reached the maximum number of event subscriptions.
" - }, - { - "shape":"SubscriptionAlreadyExistFault", - "error":{ - "code":"SubscriptionAlreadyExist", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied subscription name already exists.
" - }, - { - "shape":"SNSInvalidTopicFault", - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SNS has responded that there is a problem with the SND topic specified.
" - }, - { - "shape":"SNSNoAuthorizationFault", - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the SNS topic ARN.
" - }, - { - "shape":"SNSTopicArnNotFoundFault", - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The SNS topic ARN does not exist.
" - }, - { - "shape":"SubscriptionCategoryNotFoundFault", - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied category does not exist.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - } - ], - "documentation":"Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
" - }, - "CreateOptionGroup":{ - "name":"CreateOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateOptionGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateOptionGroupResult", - "wrapper":true, - "documentation":"", - "resultWrapper":"CreateOptionGroupResult" - }, - "errors":[ - { - "shape":"OptionGroupAlreadyExistsFault", - "error":{ - "code":"OptionGroupAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group you are trying to create already exists.
" - }, - { - "shape":"OptionGroupQuotaExceededFault", - "error":{ - "code":"OptionGroupQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota of 20 option groups was exceeded for this AWS account.
" - } - ], - "documentation":"Creates a new option group. You can create up to 20 option groups.
" - }, - "DeleteDBInstance":{ - "name":"DeleteDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"DeleteDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"DeleteDBInstanceResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - } - ], - "documentation":"The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.
" - }, - "errors":[ - { - "shape":"InvalidDBParameterGroupStateFault", - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The DB parameter group cannot be deleted because it is in use.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":"Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
" - }, - "DeleteDBSecurityGroup":{ - "name":"DeleteDBSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDBSecurityGroupMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The state of the DB security group does not allow deletion.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - } - ], - "documentation":"Deletes a DB security group.
" - }, - "DeleteDBSnapshot":{ - "name":"DeleteDBSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDBSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"DeleteDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", - "resultWrapper":"DeleteDBSnapshotResult" - }, - "errors":[ - { - "shape":"InvalidDBSnapshotStateFault", - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
" - }, - "DeleteDBSubnetGroup":{ - "name":"DeleteDBSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDBSubnetGroupMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"InvalidDBSubnetGroupStateFault", - "error":{ - "code":"InvalidDBSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The DB subnet group cannot be deleted because it is in use.
" - }, - { - "shape":"InvalidDBSubnetStateFault", - "error":{ - "code":"InvalidDBSubnetStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is not in the available state.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - } - ], - "documentation":"Deletes a DB subnet group.
" - }, - "DeleteEventSubscription":{ - "name":"DeleteEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"DeleteEventSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"DeleteEventSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"InvalidEventSubscriptionStateFault", - "error":{ - "code":"InvalidEventSubscriptionState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This error can occur if someone else is modifying a subscription. You should retry the action.
" - } - ], - "documentation":"Deletes an RDS event notification subscription.
" - }, - "DeleteOptionGroup":{ - "name":"DeleteOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteOptionGroupMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The specified option group could not be found.
" - }, - { - "shape":"InvalidOptionGroupStateFault", - "error":{ - "code":"InvalidOptionGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The option group is not in the available state.
" - } - ], - "documentation":"Deletes an existing option group.
" - }, - "DescribeDBEngineVersions":{ - "name":"DescribeDBEngineVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDBEngineVersionsMessage"}, - "output":{ - "shape":"DBEngineVersionMessage", - "documentation":"Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", - "resultWrapper":"DescribeDBEngineVersionsResult" - }, - "documentation":"Returns a list of the available DB engines.
" - }, - "DescribeDBInstances":{ - "name":"DescribeDBInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBInstancesMessage", - "documentation":"" - }, - "output":{ - "shape":"DBInstanceMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBInstances action.
", - "resultWrapper":"DescribeDBInstancesResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Returns information about provisioned RDS instances. This API supports pagination.
" - }, - "DescribeDBLogFiles":{ - "name":"DescribeDBLogFiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBLogFilesMessage", - "documentation":"" - }, - "output":{ - "shape":"DescribeDBLogFilesResponse", - "documentation":"
The response from a call to DescribeDBLogFiles.
", - "resultWrapper":"DescribeDBLogFilesResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Returns a list of DB log files for the DB instance.
" - }, - "DescribeDBParameterGroups":{ - "name":"DescribeDBParameterGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBParameterGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"DBParameterGroupsMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", - "resultWrapper":"DescribeDBParameterGroupsResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":" Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Contains the result of a successful invocation of the DescribeDBParameters action.
", - "resultWrapper":"DescribeDBParametersResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":"Returns the detailed parameter list for a particular DB parameter group.
" - }, - "DescribeDBSecurityGroups":{ - "name":"DescribeDBSecurityGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBSecurityGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"DBSecurityGroupMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", - "resultWrapper":"DescribeDBSecurityGroupsResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - } - ], - "documentation":" Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
" - }, - "output":{ - "shape":"DBSnapshotMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBSnapshots action.
", - "resultWrapper":"DescribeDBSnapshotsResult" - }, - "errors":[ - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Returns information about DB snapshots. This API supports pagination.
" - }, - "DescribeDBSubnetGroups":{ - "name":"DescribeDBSubnetGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBSubnetGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"DBSubnetGroupMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", - "resultWrapper":"DescribeDBSubnetGroupsResult" - }, - "errors":[ - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - } - ], - "documentation":"Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
" - }, - "DescribeEngineDefaultParameters":{ - "name":"DescribeEngineDefaultParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEngineDefaultParametersMessage", - "documentation":"" - }, - "output":{ - "shape":"DescribeEngineDefaultParametersResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", - "resultWrapper":"DescribeEngineDefaultParametersResult" - }, - "documentation":"Returns the default engine and system parameter information for the specified database engine.
" - }, - "DescribeEventCategories":{ - "name":"DescribeEventCategories", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventCategoriesMessage", - "documentation":"" - }, - "output":{ - "shape":"EventCategoriesMessage", - "documentation":"Data returned from the DescribeEventCategories action.
", - "resultWrapper":"DescribeEventCategoriesResult" - }, - "documentation":"Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
" - }, - "DescribeEventSubscriptions":{ - "name":"DescribeEventSubscriptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventSubscriptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"EventSubscriptionsMessage", - "documentation":"Data returned by the DescribeEventSubscriptions action.
", - "resultWrapper":"DescribeEventSubscriptionsResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - } - ], - "documentation":"Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
" - }, - "DescribeEvents":{ - "name":"DescribeEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventsMessage", - "documentation":"" - }, - "output":{ - "shape":"EventsMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeEvents action.
", - "resultWrapper":"DescribeEventsResult" - }, - "documentation":"Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
" - }, - "DescribeOptionGroupOptions":{ - "name":"DescribeOptionGroupOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOptionGroupOptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"OptionGroupOptionsMessage", - "documentation":"
", - "resultWrapper":"DescribeOptionGroupOptionsResult" - }, - "documentation":"
Describes all available options.
" - }, - "DescribeOptionGroups":{ - "name":"DescribeOptionGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOptionGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"OptionGroups", - "documentation":"
List of option groups.
", - "resultWrapper":"DescribeOptionGroupsResult" - }, - "errors":[ - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - } - ], - "documentation":"Describes the available option groups.
" - }, - "DescribeOrderableDBInstanceOptions":{ - "name":"DescribeOrderableDBInstanceOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOrderableDBInstanceOptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"OrderableDBInstanceOptionsMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", - "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" - }, - "documentation":"Returns a list of orderable DB instance options for the specified engine.
" - }, - "DescribeReservedDBInstances":{ - "name":"DescribeReservedDBInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedDBInstancesMessage", - "documentation":"" - }, - "output":{ - "shape":"ReservedDBInstanceMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", - "resultWrapper":"DescribeReservedDBInstancesResult" - }, - "errors":[ - { - "shape":"ReservedDBInstanceNotFoundFault", - "error":{ - "code":"ReservedDBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified reserved DB Instance not found.
" - } - ], - "documentation":"Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
" - }, - "DescribeReservedDBInstancesOfferings":{ - "name":"DescribeReservedDBInstancesOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedDBInstancesOfferingsMessage", - "documentation":"" - }, - "output":{ - "shape":"ReservedDBInstancesOfferingMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", - "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" - }, - "errors":[ - { - "shape":"ReservedDBInstancesOfferingNotFoundFault", - "error":{ - "code":"ReservedDBInstancesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - } - ], - "documentation":"Lists available reserved DB instance offerings.
" - }, - "DownloadDBLogFilePortion":{ - "name":"DownloadDBLogFilePortion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DownloadDBLogFilePortionMessage", - "documentation":"" - }, - "output":{ - "shape":"DownloadDBLogFilePortionDetails", - "documentation":"
This data type is used as a response element to DownloadDBLogFilePortion.
", - "resultWrapper":"DownloadDBLogFilePortionResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Downloads all or a portion of the specified log file.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListTagsForResourceMessage", - "documentation":"" - }, - "output":{ - "shape":"TagListMessage", - "documentation":"", - "resultWrapper":"ListTagsForResourceResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
" - }, - "ModifyDBInstance":{ - "name":"ModifyDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"ModifyDBInstanceResult" - }, - "errors":[ - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - }, - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"DBUpgradeDependencyFailureFault", - "error":{ - "code":"DBUpgradeDependencyFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB upgrade failed because a resource the DB depends on could not be modified.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - } - ], - "documentation":"Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
" - }, - "ModifyDBParameterGroup":{ - "name":"ModifyDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyDBParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"DBParameterGroupNameMessage", - "documentation":"
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", - "resultWrapper":"ModifyDBParameterGroupResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"InvalidDBParameterGroupStateFault", - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB parameter group cannot be deleted because it is in use.
" - } - ], - "documentation":" Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
" - }, - "output":{ - "shape":"ModifyDBSubnetGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", - "resultWrapper":"ModifyDBSubnetGroupResult" - }, - "errors":[ - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetQuotaExceededFault", - "error":{ - "code":"DBSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
" - }, - { - "shape":"SubnetAlreadyInUse", - "error":{ - "code":"SubnetAlreadyInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is already in use in the Availability Zone.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - } - ], - "documentation":"Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
" - }, - "ModifyEventSubscription":{ - "name":"ModifyEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyEventSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"ModifyEventSubscriptionResult" - }, - "errors":[ - { - "shape":"EventSubscriptionQuotaExceededFault", - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You have reached the maximum number of event subscriptions.
" - }, - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"SNSInvalidTopicFault", - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SNS has responded that there is a problem with the SND topic specified.
" - }, - { - "shape":"SNSNoAuthorizationFault", - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the SNS topic ARN.
" - }, - { - "shape":"SNSTopicArnNotFoundFault", - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The SNS topic ARN does not exist.
" - }, - { - "shape":"SubscriptionCategoryNotFoundFault", - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied category does not exist.
" - } - ], - "documentation":"Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" - }, - "ModifyOptionGroup":{ - "name":"ModifyOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyOptionGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyOptionGroupResult", - "wrapper":true, - "documentation":"
", - "resultWrapper":"ModifyOptionGroupResult" - }, - "errors":[ - { - "shape":"InvalidOptionGroupStateFault", - "error":{ - "code":"InvalidOptionGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group is not in the available state.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - } - ], - "documentation":"Modifies an existing option group.
" - }, - "PromoteReadReplica":{ - "name":"PromoteReadReplica", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PromoteReadReplicaMessage", - "documentation":"" - }, - "output":{ - "shape":"PromoteReadReplicaResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"PromoteReadReplicaResult" - }, - "errors":[ - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Promotes a read replica DB instance to a standalone DB instance.
" - }, - "PurchaseReservedDBInstancesOffering":{ - "name":"PurchaseReservedDBInstancesOffering", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PurchaseReservedDBInstancesOfferingMessage", - "documentation":"" - }, - "output":{ - "shape":"PurchaseReservedDBInstancesOfferingResult", - "wrapper":true, - "documentation":"
This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", - "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" - }, - "errors":[ - { - "shape":"ReservedDBInstancesOfferingNotFoundFault", - "error":{ - "code":"ReservedDBInstancesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - }, - { - "shape":"ReservedDBInstanceAlreadyExistsFault", - "error":{ - "code":"ReservedDBInstanceAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a reservation with the given identifier.
" - }, - { - "shape":"ReservedDBInstanceQuotaExceededFault", - "error":{ - "code":"ReservedDBInstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would exceed the user's DB Instance quota.
" - } - ], - "documentation":"Purchases a reserved DB instance offering.
" - }, - "RebootDBInstance":{ - "name":"RebootDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RebootDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"RebootDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"RebootDBInstanceResult" - }, - "errors":[ - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
" - }, - "RemoveSourceIdentifierFromSubscription":{ - "name":"RemoveSourceIdentifierFromSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveSourceIdentifierFromSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"RemoveSourceIdentifierFromSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - } - ], - "documentation":"Removes a source identifier from an existing RDS event notification subscription.
" - }, - "RemoveTagsFromResource":{ - "name":"RemoveTagsFromResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveTagsFromResourceMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
" - }, - "ResetDBParameterGroup":{ - "name":"ResetDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ResetDBParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"DBParameterGroupNameMessage", - "documentation":"
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", - "resultWrapper":"ResetDBParameterGroupResult" - }, - "errors":[ - { - "shape":"InvalidDBParameterGroupStateFault", - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB parameter group cannot be deleted because it is in use.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":" Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
" - }, - "output":{ - "shape":"RestoreDBInstanceFromDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"InvalidDBSnapshotStateFault", - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"InvalidRestoreFault", - "error":{ - "code":"InvalidRestoreFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - } - ], - "documentation":"Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
" - }, - "RestoreDBInstanceToPointInTime":{ - "name":"RestoreDBInstanceToPointInTime", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RestoreDBInstanceToPointInTimeMessage", - "documentation":"" - }, - "output":{ - "shape":"RestoreDBInstanceToPointInTimeResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"RestoreDBInstanceToPointInTimeResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"PointInTimeRestoreNotEnabledFault", - "error":{ - "code":"PointInTimeRestoreNotEnabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"InvalidRestoreFault", - "error":{ - "code":"InvalidRestoreFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - } - ], - "documentation":"Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
" - }, - "RevokeDBSecurityGroupIngress":{ - "name":"RevokeDBSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RevokeDBSecurityGroupIngressMessage", - "documentation":"" - }, - "output":{ - "shape":"RevokeDBSecurityGroupIngressResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", - "resultWrapper":"RevokeDBSecurityGroupIngressResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - } - ], - "documentation":"Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" - } - }, - "shapes":{ - "AddSourceIdentifierToSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SourceIdentifier" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the RDS event notification subscription you want to add a source identifier to.
" - }, - "SourceIdentifier":{ - "shape":"String", - "documentation":"The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The tags to be assigned to the Amazon RDS resource.
" - } - }, - "documentation":"" - }, - "ApplyMethod":{ - "type":"string", - "enum":[ - "immediate", - "pending-reboot" - ] - }, - "AuthorizationAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
" - }, - "AuthorizationNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - "AuthorizationQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB security group authorization quota has been reached.
" - }, - "AuthorizeDBSecurityGroupIngressMessage":{ - "type":"structure", - "required":["DBSecurityGroupName"], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the DB security group to add authorization to.
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":"The IP range to authorize.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":" Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
" - }, - "AvailabilityZone":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"
The name of the availability zone.
" - } - }, - "wrapper":true, - "documentation":"Contains Availability Zone information.
This data type is used as an element in the following data type:
" - }, - "AvailabilityZoneList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZone", - "locationName":"AvailabilityZone" - } - }, - "Boolean":{"type":"boolean"}, - "BooleanOptional":{"type":"boolean"}, - "CharacterSet":{ - "type":"structure", - "members":{ - "CharacterSetName":{ - "shape":"String", - "documentation":"The name of the character set.
" - }, - "CharacterSetDescription":{ - "shape":"String", - "documentation":"The description of the character set.
" - } - }, - "documentation":"This data type is used as a response element in the action DescribeDBEngineVersions.
" - }, - "CopyDBParameterGroupMessage":{ - "type":"structure", - "required":[ - "SourceDBParameterGroupIdentifier", - "TargetDBParameterGroupIdentifier", - "TargetDBParameterGroupDescription" - ], - "members":{ - "SourceDBParameterGroupIdentifier":{ - "shape":"String", - "documentation":"The identifier or ARN for the source DB Parameter Group.
Constraints:
Example: my-db-param-group
Example: arn:aws:rds:us-west-2:123456789012:pg:special-parameters
The identifier for the copied DB Parameter Group.
Constraints:
Example: my-db-parameter-group
The description for the copied DB Parameter Group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CopyDBSnapshotMessage":{ - "type":"structure", - "required":[ - "SourceDBSnapshotIdentifier", - "TargetDBSnapshotIdentifier" - ], - "members":{ - "SourceDBSnapshotIdentifier":{ - "shape":"String", - "documentation":"
The identifier for the source DB snapshot.
Constraints:
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copied snapshot.
Constraints:
Example: my-db-snapshot
" - }, - "CopyOptionGroupMessage":{ - "type":"structure", - "required":[ - "SourceOptionGroupIdentifier", - "TargetOptionGroupIdentifier", - "TargetOptionGroupDescription" - ], - "members":{ - "SourceOptionGroupIdentifier":{ - "shape":"String", - "documentation":"
The identifier or ARN for the source Option Group.
Constraints:
Example: my-option-group
Example: arn:aws:rds:us-west-2:123456789012:og:special-options
The identifier for the copied Option Group.
Constraints:
Example: my-option-group
The description for the copied Option Group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateDBInstanceMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "AllocatedStorage", - "DBInstanceClass", - "Engine", - "MasterUsername", - "MasterUserPassword" - ], - "members":{ - "DBName":{ - "shape":"String", - "documentation":"
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
" - }, - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The compute and memory capacity of the DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The name of the database engine to be used for this instance.
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
The name of master user for the client DB instance.
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
" - }, - "DBSecurityGroups":{ - "shape":"DBSecurityGroupNameList", - "documentation":"A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
" - }, - "VpcSecurityGroupIds":{ - "shape":"VpcSecurityGroupIdList", - "documentation":"A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which system maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
" - }, - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version number of the database engine to use.
MySQL
Example: 5.1.42
Type: String
PostgreSQL
Example: 9.3
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: To use PIOPS, this value must be an integer greater than 1000.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "CharacterSetName":{ - "shape":"String", - "documentation":"For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
" - }, - "PubliclyAccessible":{ - "shape":"BooleanOptional", - "documentation":"Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "Tags":{"shape":"TagList"}, - "StorageType":{ - "shape":"String", - "documentation":"Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "CreateDBInstanceReadReplicaMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "SourceDBInstanceIdentifier" - ], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
The DB instance identifier of the read replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
" - }, - "SourceDBInstanceIdentifier":{ - "shape":"String", - "documentation":"The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.
Constraints:
The compute and memory capacity of the read replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: Inherits from the source DB instance.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Amazon EC2 Availability Zone that the read replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Indicates that minor engine upgrades will be applied automatically to the read replica during the maintenance window.
Default: Inherits from the source DB instance
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
" - }, - "PubliclyAccessible":{ - "shape":"BooleanOptional", - "documentation":"Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "Tags":{"shape":"TagList"}, - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
Specifies storage type to be associated with the DB Instance read replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
The name of the DB parameter group.
Constraints:
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description for the DB parameter group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateDBSecurityGroupMessage":{ - "type":"structure", - "required":[ - "DBSecurityGroupName", - "DBSecurityGroupDescription" - ], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"
The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Example: mysecuritygroup
The description for the DB security group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateDBSnapshotMessage":{ - "type":"structure", - "required":[ - "DBSnapshotIdentifier", - "DBInstanceIdentifier" - ], - "members":{ - "DBSnapshotIdentifier":{ - "shape":"String", - "documentation":"
The identifier for the DB snapshot.
Constraints:
Example: my-snapshot-id
The DB instance identifier. This is the unique key that identifies a DB instance.
Constraints:
" - }, - "CreateDBSubnetGroupMessage":{ - "type":"structure", - "required":[ - "DBSubnetGroupName", - "DBSubnetGroupDescription", - "SubnetIds" - ], - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"The EC2 Subnet IDs for the DB subnet group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateEventSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SnsTopicArn" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the subscription.
Constraints: The name must be less than 255 characters.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" - }, - "SourceIds":{ - "shape":"SourceIdsList", - "documentation":"The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateOptionGroupMessage":{ - "type":"structure", - "required":[ - "OptionGroupName", - "EngineName", - "MajorEngineVersion", - "OptionGroupDescription" - ], - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the option group to be created.
Constraints:
Example: myoptiongroup
Specifies the name of the engine that this option group should be associated with.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Specifies the major version of the engine that this option group should be associated with.
" - }, - "OptionGroupDescription":{ - "shape":"String", - "documentation":"The description of the option group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "DBEngineVersion":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"The name of the database engine.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version number of the database engine.
" - }, - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the DB parameter group family for the database engine.
" - }, - "DBEngineDescription":{ - "shape":"String", - "documentation":"The description of the database engine.
" - }, - "DBEngineVersionDescription":{ - "shape":"String", - "documentation":"The description of the database engine version.
" - }, - "DefaultCharacterSet":{ - "shape":"CharacterSet", - "documentation":" The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
This data type is used as a response element in the action DescribeDBEngineVersions.
" - }, - "DBEngineVersionList":{ - "type":"list", - "member":{ - "shape":"DBEngineVersion", - "locationName":"DBEngineVersion" - } - }, - "DBEngineVersionMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
" - }, - "DBInstance":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"Contains the name of the compute and memory capacity class of the DB instance.
" - }, - "Engine":{ - "shape":"String", - "documentation":"Provides the name of the database engine to be used for this DB instance.
" - }, - "DBInstanceStatus":{ - "shape":"String", - "documentation":"Specifies the current state of this database.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"Contains the master username for the DB instance.
" - }, - "DBName":{ - "shape":"String", - "documentation":"The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.
MySQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" - }, - "Endpoint":{ - "shape":"Endpoint", - "documentation":"Specifies the connection endpoint.
" - }, - "AllocatedStorage":{ - "shape":"Integer", - "documentation":"Specifies the allocated storage size specified in gigabytes.
" - }, - "InstanceCreateTime":{ - "shape":"TStamp", - "documentation":"Provides the date and time the DB instance was created.
" - }, - "PreferredBackupWindow":{ - "shape":"String", - "documentation":" Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the number of days for which automatic DB snapshots are retained.
" - }, - "DBSecurityGroups":{ - "shape":"DBSecurityGroupMembershipList", - "documentation":" Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
Provides List of VPC security group elements that the DB instance belongs to.
" - }, - "DBParameterGroups":{ - "shape":"DBParameterGroupStatusList", - "documentation":"Provides the list of DB parameter groups applied to this DB instance.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"Specifies the name of the Availability Zone the DB instance is located in.
" - }, - "DBSubnetGroup":{ - "shape":"DBSubnetGroup", - "documentation":"Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"Specifies the weekly time range (in UTC) during which system maintenance can occur.
" - }, - "PendingModifiedValues":{ - "shape":"PendingModifiedValues", - "documentation":"Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" - }, - "LatestRestorableTime":{ - "shape":"TStamp", - "documentation":"Specifies the latest time to which a database can be restored with point-in-time restore.
" - }, - "MultiAZ":{ - "shape":"Boolean", - "documentation":"Specifies if the DB instance is a Multi-AZ deployment.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"Indicates the database engine version.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"Indicates that minor version patches are applied automatically.
" - }, - "ReadReplicaSourceDBInstanceIdentifier":{ - "shape":"String", - "documentation":"Contains the identifier of the source DB instance if this DB instance is a read replica.
" - }, - "ReadReplicaDBInstanceIdentifiers":{ - "shape":"ReadReplicaDBInstanceIdentifierList", - "documentation":"Contains one or more identifiers of the read replicas associated with this DB instance.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for this DB instance.
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"Specifies the Provisioned IOPS (I/O operations per second) value.
" - }, - "OptionGroupMemberships":{ - "shape":"OptionGroupMembershipList", - "documentation":"Provides the list of option group memberships for this DB instance.
" - }, - "CharacterSetName":{ - "shape":"String", - "documentation":"If present, specifies the name of the character set that this instance is associated with.
" - }, - "SecondaryAvailabilityZone":{ - "shape":"String", - "documentation":"If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
" - }, - "PubliclyAccessible":{ - "shape":"Boolean", - "documentation":"Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "StatusInfos":{ - "shape":"DBInstanceStatusInfoList", - "documentation":"The status of a read replica. If the instance is not a read replica, this will be blank.
" - }, - "StorageType":{ - "shape":"String", - "documentation":"Specifies storage type associated with DB Instance.
" - }, - "TdeCredentialArn":{ - "shape":"String", - "documentation":"The ARN from the Key Store with which the instance is associated for TDE encryption.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
" - }, - "DBInstanceAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - "DBInstanceList":{ - "type":"list", - "member":{ - "shape":"DBInstance", - "locationName":"DBInstance" - } - }, - "DBInstanceMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
A list of DBInstance instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBInstances action.
" - }, - "DBInstanceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - "DBInstanceStatusInfo":{ - "type":"structure", - "members":{ - "StatusType":{ - "shape":"String", - "documentation":"This value is currently \"read replication.\"
" - }, - "Normal":{ - "shape":"Boolean", - "documentation":"Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
" - }, - "Status":{ - "shape":"String", - "documentation":"Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
" - }, - "Message":{ - "shape":"String", - "documentation":"Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
" - } - }, - "documentation":"Provides a list of status information for a DB instance.
" - }, - "DBInstanceStatusInfoList":{ - "type":"list", - "member":{ - "shape":"DBInstanceStatusInfo", - "locationName":"DBInstanceStatusInfo" - } - }, - "DBParameterGroup":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"Provides the name of the DB parameter group.
" - }, - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"Provides the name of the DB parameter group family that this DB parameter group is compatible with.
" - }, - "Description":{ - "shape":"String", - "documentation":"Provides the customer-specified description for this DB parameter group.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
" - }, - "DBParameterGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB parameter group with the same name exists.
" - }, - "DBParameterGroupDetails":{ - "type":"structure", - "members":{ - "Parameters":{ - "shape":"ParametersList", - "documentation":"A list of Parameter values.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains the result of a successful invocation of the DescribeDBParameters action.
" - }, - "DBParameterGroupList":{ - "type":"list", - "member":{ - "shape":"DBParameterGroup", - "locationName":"DBParameterGroup" - } - }, - "DBParameterGroupNameMessage":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group.
" - } - }, - "documentation":"Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
" - }, - "DBParameterGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - "DBParameterGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
" - }, - "DBParameterGroupStatus":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DP parameter group.
" - }, - "ParameterApplyStatus":{ - "shape":"String", - "documentation":"The status of parameter updates.
" - } - }, - "documentation":"The status of the DB parameter group.
This data type is used as a response element in the following actions:
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBParameterGroup instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBParameterGroups action.
" - }, - "DBSecurityGroup":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"Provides the AWS ID of the owner of a specific DB security group.
" - }, - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the DB security group.
" - }, - "DBSecurityGroupDescription":{ - "shape":"String", - "documentation":"Provides the description of the DB security group.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"Provides the VpcId of the DB security group.
" - }, - "EC2SecurityGroups":{ - "shape":"EC2SecurityGroupList", - "documentation":"Contains a list of EC2SecurityGroup elements.
" - }, - "IPRanges":{ - "shape":"IPRangeList", - "documentation":"Contains a list of IPRange elements.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
" - }, - "DBSecurityGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSecurityGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group with the name specified in DBSecurityGroupName already exists.
" - }, - "DBSecurityGroupMembership":{ - "type":"structure", - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the DB security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the DB security group.
" - } - }, - "documentation":"This data type is used as a response element in the following actions:
" - }, - "DBSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"DBSecurityGroupMembership", - "locationName":"DBSecurityGroup" - } - }, - "DBSecurityGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBSecurityGroup instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
" - }, - "DBSecurityGroupNameList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"DBSecurityGroupName" - } - }, - "DBSecurityGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - "DBSecurityGroupNotSupportedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSecurityGroupNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group is not allowed for this action.
" - }, - "DBSecurityGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"QuotaExceeded.DBSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB security groups.
" - }, - "DBSecurityGroups":{ - "type":"list", - "member":{ - "shape":"DBSecurityGroup", - "locationName":"DBSecurityGroup" - } - }, - "DBSnapshot":{ - "type":"structure", - "members":{ - "DBSnapshotIdentifier":{ - "shape":"String", - "documentation":"Specifies the identifier for the DB snapshot.
" - }, - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
" - }, - "SnapshotCreateTime":{ - "shape":"TStamp", - "documentation":"Provides the time (UTC) when the snapshot was taken.
" - }, - "Engine":{ - "shape":"String", - "documentation":"Specifies the name of the database engine.
" - }, - "AllocatedStorage":{ - "shape":"Integer", - "documentation":"Specifies the allocated storage size in gigabytes (GB).
" - }, - "Status":{ - "shape":"String", - "documentation":"Specifies the status of this DB snapshot.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"Specifies the port that the database engine was listening on at the time of the snapshot.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"Provides the Vpc Id associated with the DB snapshot.
" - }, - "InstanceCreateTime":{ - "shape":"TStamp", - "documentation":"Specifies the time (UTC) when the snapshot was taken.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"Provides the master username for the DB snapshot.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"Specifies the version of the database engine.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for the restored DB instance.
" - }, - "SnapshotType":{ - "shape":"String", - "documentation":"Provides the type of the DB snapshot.
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"Provides the option group name for the DB snapshot.
" - }, - "PercentProgress":{ - "shape":"Integer", - "documentation":"The percentage of the estimated data that has been transferred.
" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The region that the DB snapshot was created in or copied from.
" - }, - "StorageType":{ - "shape":"String", - "documentation":"Specifies storage type associated with DB Snapshot.
" - }, - "TdeCredentialArn":{ - "shape":"String", - "documentation":"The ARN from the Key Store with which to associate the instance for TDE encryption.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
" - }, - "DBSnapshotAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - "DBSnapshotList":{ - "type":"list", - "member":{ - "shape":"DBSnapshot", - "locationName":"DBSnapshot" - } - }, - "DBSnapshotMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBSnapshot instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBSnapshots action.
" - }, - "DBSnapshotNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - }, - "DBSubnetGroup":{ - "type":"structure", - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the DB subnet group.
" - }, - "DBSubnetGroupDescription":{ - "shape":"String", - "documentation":"Provides the description of the DB subnet group.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"Provides the VpcId of the DB subnet group.
" - }, - "SubnetGroupStatus":{ - "shape":"String", - "documentation":"Provides the status of the DB subnet group.
" - }, - "Subnets":{ - "shape":"SubnetList", - "documentation":"Contains a list of Subnet elements.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
" - }, - "DBSubnetGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName is already used by an existing DB subnet group.
" - }, - "DBSubnetGroupDoesNotCoverEnoughAZs":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - "DBSubnetGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBSubnetGroup instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
" - }, - "DBSubnetGroupNotAllowedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupNotAllowedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
" - }, - "DBSubnetGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - "DBSubnetGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB subnet groups.
" - }, - "DBSubnetGroups":{ - "type":"list", - "member":{ - "shape":"DBSubnetGroup", - "locationName":"DBSubnetGroup" - } - }, - "DBSubnetQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
" - }, - "DBUpgradeDependencyFailureFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBUpgradeDependencyFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB upgrade failed because a resource the DB depends on could not be modified.
" - }, - "DeleteDBInstanceMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
Constraints:
Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
Specify true when deleting a read replica.
Default: false
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Constraints:
" - }, - "DeleteDBParameterGroupMessage":{ - "type":"structure", - "required":["DBParameterGroupName"], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"
The name of the DB parameter group.
Constraints:
" - }, - "DeleteDBSecurityGroupMessage":{ - "type":"structure", - "required":["DBSecurityGroupName"], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"
The name of the DB security group to delete.
Constraints:
" - }, - "DeleteDBSnapshotMessage":{ - "type":"structure", - "required":["DBSnapshotIdentifier"], - "members":{ - "DBSnapshotIdentifier":{ - "shape":"String", - "documentation":"
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
" - }, - "DeleteDBSubnetGroupMessage":{ - "type":"structure", - "required":["DBSubnetGroupName"], - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the database subnet group to delete.
Constraints:
" - }, - "DeleteEventSubscriptionMessage":{ - "type":"structure", - "required":["SubscriptionName"], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the RDS event notification subscription you want to delete.
" - } - }, - "documentation":"" - }, - "DeleteOptionGroupMessage":{ - "type":"structure", - "required":["OptionGroupName"], - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be deleted.
" - } - }, - "documentation":"" - }, - "DescribeDBEngineVersionsMessage":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"
The database engine to return.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
Not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Indicates that only the default version of the specified engine or engine and major version combination is returned.
" - }, - "ListSupportedCharacterSets":{ - "shape":"BooleanOptional", - "documentation":"If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
" - } - } - }, - "DescribeDBInstancesMessage":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.
Constraints:
This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
" - }, - "DescribeDBLogFilesDetails":{ - "type":"structure", - "members":{ - "LogFileName":{ - "shape":"String", - "documentation":"
The name of the log file for the specified DB instance.
" - }, - "LastWritten":{ - "shape":"Long", - "documentation":"A POSIX timestamp when the last log entry was written.
" - }, - "Size":{ - "shape":"Long", - "documentation":"The size, in bytes, of the log file for the specified DB instance.
" - } - }, - "documentation":"This data type is used as a response element to DescribeDBLogFiles.
" - }, - "DescribeDBLogFilesList":{ - "type":"list", - "member":{ - "shape":"DescribeDBLogFilesDetails", - "locationName":"DescribeDBLogFilesDetails" - } - }, - "DescribeDBLogFilesMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Filters the available log files for log file names that contain the specified string.
" - }, - "FileLastWritten":{ - "shape":"Long", - "documentation":"Filters the available log files for files written since the specified date, in POSIX timestamp format.
" - }, - "FileSize":{ - "shape":"Long", - "documentation":"Filters the available log files for files larger than the specified size.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
" - }, - "Marker":{ - "shape":"String", - "documentation":"The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
" - } - }, - "documentation":"" - }, - "DescribeDBLogFilesResponse":{ - "type":"structure", - "members":{ - "DescribeDBLogFiles":{ - "shape":"DescribeDBLogFilesList", - "documentation":"
The DB log files returned.
" - }, - "Marker":{ - "shape":"String", - "documentation":"A pagination token that can be used in a subsequent DescribeDBLogFiles request.
" - } - }, - "documentation":"The response from a call to DescribeDBLogFiles.
" - }, - "DescribeDBParameterGroupsMessage":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of a specific DB parameter group to return details for.
Constraints:
This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeDBParametersMessage":{ - "type":"structure", - "required":["DBParameterGroupName"], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"
The name of a specific DB parameter group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeDBSnapshotsMessage":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.
Constraints:
A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeDBSubnetGroupsMessage":{ - "type":"structure", - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the DB subnet group to return details for.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeEngineDefaultParametersMessage":{ - "type":"structure", - "required":["DBParameterGroupFamily"], - "members":{ - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"
The name of the DB parameter group family.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"Not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeEventCategoriesMessage":{ - "type":"structure", - "members":{ - "SourceType":{ - "shape":"String", - "documentation":"
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - } - }, - "documentation":"" - }, - "DescribeEventSubscriptionsMessage":{ - "type":"structure", - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the RDS event notification subscription you want to describe.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
Constraints:
DBInstance, then a DBInstanceIdentifier must be supplied.DBSecurityGroup, a DBSecurityGroupName must be supplied.DBParameterGroup, a DBParameterGroupName must be supplied.DBSnapshot, a DBSnapshotIdentifier must be supplied.The event source to retrieve events for. If no value is specified, all events are returned.
" - }, - "StartTime":{ - "shape":"TStamp", - "documentation":"The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
" - }, - "EndTime":{ - "shape":"TStamp", - "documentation":"The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
" - }, - "Duration":{ - "shape":"IntegerOptional", - "documentation":"The number of minutes to retrieve events for.
Default: 60
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories that trigger notifications for a event notification subscription.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeOptionGroupOptionsMessage":{ - "type":"structure", - "required":["EngineName"], - "members":{ - "EngineName":{ - "shape":"String", - "documentation":"
A required parameter. Options available for the given Engine name will be described.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"If specified, filters the results to include only options for the specified major engine version.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeOptionGroupsMessage":{ - "type":"structure", - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "EngineName":{ - "shape":"String", - "documentation":"Filters the list of option groups to only include groups associated with a specific database engine.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
" - } - }, - "documentation":"" - }, - "DescribeOrderableDBInstanceOptionsMessage":{ - "type":"structure", - "required":["Engine"], - "members":{ - "Engine":{ - "shape":"String", - "documentation":"
The name of the engine to retrieve DB instance options for.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
" - }, - "Vpc":{ - "shape":"BooleanOptional", - "documentation":"The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
" - }, - "DescribeReservedDBInstancesMessage":{ - "type":"structure", - "members":{ - "ReservedDBInstanceId":{ - "shape":"String", - "documentation":"
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
" - }, - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
" - }, - "Duration":{ - "shape":"String", - "documentation":"The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeReservedDBInstancesOfferingsMessage":{ - "type":"structure", - "members":{ - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" - }, - "Duration":{ - "shape":"String", - "documentation":"Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "Double":{"type":"double"}, - "DownloadDBLogFilePortionDetails":{ - "type":"structure", - "members":{ - "LogFileData":{ - "shape":"String", - "documentation":"
Entries from the specified log file.
" - }, - "Marker":{ - "shape":"String", - "documentation":"A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
" - }, - "AdditionalDataPending":{ - "shape":"Boolean", - "documentation":"Boolean value that if true, indicates there is more data to be downloaded.
" - } - }, - "documentation":"This data type is used as a response element to DownloadDBLogFilePortion.
" - }, - "DownloadDBLogFilePortionMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "LogFileName" - ], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
The name of the log file to be downloaded.
" - }, - "Marker":{ - "shape":"String", - "documentation":"The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
" - }, - "NumberOfLines":{ - "shape":"Integer", - "documentation":"The number of lines to download.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
" - }, - "EC2SecurityGroup":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"
Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the EC2 security group.
" - }, - "EC2SecurityGroupId":{ - "shape":"String", - "documentation":"Specifies the id of the EC2 security group.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":" Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
This data type is used as a response element in the following actions:
" - }, - "EC2SecurityGroupList":{ - "type":"list", - "member":{ - "shape":"EC2SecurityGroup", - "locationName":"EC2SecurityGroup" - } - }, - "Endpoint":{ - "type":"structure", - "members":{ - "Address":{ - "shape":"String", - "documentation":"Specifies the DNS address of the DB instance.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"Specifies the port that the database engine is listening on.
" - } - }, - "documentation":"This data type is used as a response element in the following actions:
" - }, - "EngineDefaults":{ - "type":"structure", - "members":{ - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"Specifies the name of the DB parameter group family which the engine default parameters apply to.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Contains a list of engine default parameters.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
" - }, - "Event":{ - "type":"structure", - "members":{ - "SourceIdentifier":{ - "shape":"String", - "documentation":"Provides the identifier for the source of the event.
" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"Specifies the source type for this event.
" - }, - "Message":{ - "shape":"String", - "documentation":"Provides the text of this event.
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"Specifies the category for the event.
" - }, - "Date":{ - "shape":"TStamp", - "documentation":"Specifies the date and time of the event.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeEvents action.
" - }, - "EventCategoriesList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"EventCategory" - } - }, - "EventCategoriesMap":{ - "type":"structure", - "members":{ - "SourceType":{ - "shape":"String", - "documentation":"The source type that the returned categories belong to
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"The event categories for the specified source type
" - } - }, - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventCategories action.
" - }, - "EventCategoriesMapList":{ - "type":"list", - "member":{ - "shape":"EventCategoriesMap", - "locationName":"EventCategoriesMap" - } - }, - "EventCategoriesMessage":{ - "type":"structure", - "members":{ - "EventCategoriesMapList":{ - "shape":"EventCategoriesMapList", - "documentation":"A list of EventCategoriesMap data types.
" - } - }, - "documentation":"Data returned from the DescribeEventCategories action.
" - }, - "EventList":{ - "type":"list", - "member":{ - "shape":"Event", - "locationName":"Event" - } - }, - "EventSubscription":{ - "type":"structure", - "members":{ - "CustomerAwsId":{ - "shape":"String", - "documentation":"The AWS customer account associated with the RDS event notification subscription.
" - }, - "CustSubscriptionId":{ - "shape":"String", - "documentation":"The RDS event notification subscription Id.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The topic ARN of the RDS event notification subscription.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
" - }, - "SubscriptionCreationTime":{ - "shape":"String", - "documentation":"The time the RDS event notification subscription was created.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The source type for the RDS event notification subscription.
" - }, - "SourceIdsList":{ - "shape":"SourceIdsList", - "documentation":"A list of source IDs for the RDS event notification subscription.
" - }, - "EventCategoriesList":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories for the RDS event notification subscription.
" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
" - } - }, - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
" - }, - "EventSubscriptionQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You have reached the maximum number of event subscriptions.
" - }, - "EventSubscriptionsList":{ - "type":"list", - "member":{ - "shape":"EventSubscription", - "locationName":"EventSubscription" - } - }, - "EventSubscriptionsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of EventSubscriptions data types.
" - } - }, - "documentation":"Data returned by the DescribeEventSubscriptions action.
" - }, - "EventsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
A list of Event instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeEvents action.
" - }, - "Filter":{ - "type":"structure", - "required":[ - "Name", - "Values" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"This parameter is not currently supported.
" - }, - "Values":{ - "shape":"FilterValueList", - "documentation":"This parameter is not currently supported.
" - } - } - }, - "FilterList":{ - "type":"list", - "member":{ - "shape":"Filter", - "locationName":"Filter" - } - }, - "FilterValueList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"Value" - } - }, - "IPRange":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":"Specifies the IP range.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeDBSecurityGroups action.
" - }, - "IPRangeList":{ - "type":"list", - "member":{ - "shape":"IPRange", - "locationName":"IPRange" - } - }, - "InstanceQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - "InsufficientDBInstanceCapacityFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - "Integer":{"type":"integer"}, - "IntegerOptional":{"type":"integer"}, - "InvalidDBInstanceStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - "InvalidDBParameterGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB parameter group cannot be deleted because it is in use.
" - }, - "InvalidDBSecurityGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - }, - "InvalidDBSnapshotStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - "InvalidDBSubnetGroupFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSubnetGroupFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
" - }, - "InvalidDBSubnetGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet group cannot be deleted because it is in use.
" - }, - "InvalidDBSubnetStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSubnetStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is not in the available state.
" - }, - "InvalidEventSubscriptionStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidEventSubscriptionState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This error can occur if someone else is modifying a subscription. You should retry the action.
" - }, - "InvalidOptionGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidOptionGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The option group is not in the available state.
" - }, - "InvalidRestoreFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidRestoreFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
" - }, - "InvalidSubnet":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - "InvalidVPCNetworkStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - "KeyList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListTagsForResourceMessage":{ - "type":"structure", - "required":["ResourceName"], - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":"The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - } - }, - "documentation":"" - }, - "Long":{"type":"long"}, - "ModifyDBInstanceMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier. This value is stored as a lowercase string.
Constraints:
The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.
If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.
Default: false
The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
" - }, - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
" - }, - "BackupRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":" Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB instance is a read replica.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":" The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
Example: 5.1.42
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":" Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":" Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "NewDBInstanceIdentifier":{ - "shape":"String", - "documentation":" The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "ModifyDBParameterGroupMessage":{ - "type":"structure", - "required":[ - "DBParameterGroupName", - "Parameters" - ], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"
The name of the DB parameter group.
Constraints:
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
" - }, - "ModifyDBSubnetGroupMessage":{ - "type":"structure", - "required":[ - "DBSubnetGroupName", - "SubnetIds" - ], - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"The EC2 subnet IDs for the DB subnet group.
" - } - }, - "documentation":"" - }, - "ModifyEventSubscriptionMessage":{ - "type":"structure", - "required":["SubscriptionName"], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the RDS event notification subscription.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" - }, - "Enabled":{ - "shape":"BooleanOptional", - "documentation":"A Boolean value; set to true to activate the subscription.
" - } - }, - "documentation":"" - }, - "ModifyOptionGroupMessage":{ - "type":"structure", - "required":["OptionGroupName"], - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "OptionsToInclude":{ - "shape":"OptionConfigurationList", - "documentation":"Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
" - }, - "OptionsToRemove":{ - "shape":"OptionNamesList", - "documentation":"Options in this list are removed from the option group.
" - }, - "ApplyImmediately":{ - "shape":"Boolean", - "documentation":"Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
" - } - }, - "documentation":"" - }, - "Option":{ - "type":"structure", - "members":{ - "OptionName":{ - "shape":"String", - "documentation":"
The name of the option.
" - }, - "OptionDescription":{ - "shape":"String", - "documentation":"The description of the option.
" - }, - "Persistent":{ - "shape":"Boolean", - "documentation":"Indicate if this option is persistent.
" - }, - "Permanent":{ - "shape":"Boolean", - "documentation":"Indicate if this option is permanent.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"If required, the port configured for this option to use.
" - }, - "OptionSettings":{ - "shape":"OptionSettingConfigurationList", - "documentation":"The option settings for this option.
" - }, - "DBSecurityGroupMemberships":{ - "shape":"DBSecurityGroupMembershipList", - "documentation":"If the option requires access to a port, then this DB security group allows access to the port.
" - }, - "VpcSecurityGroupMemberships":{ - "shape":"VpcSecurityGroupMembershipList", - "documentation":"If the option requires access to a port, then this VPC security group allows access to the port.
" - } - }, - "documentation":"Option details.
" - }, - "OptionConfiguration":{ - "type":"structure", - "required":["OptionName"], - "members":{ - "OptionName":{ - "shape":"String", - "documentation":"The configuration of options to include in a group.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The optional port for the option.
" - }, - "DBSecurityGroupMemberships":{ - "shape":"DBSecurityGroupNameList", - "documentation":"A list of DBSecurityGroupMemebrship name strings used for this option.
" - }, - "VpcSecurityGroupMemberships":{ - "shape":"VpcSecurityGroupIdList", - "documentation":"A list of VpcSecurityGroupMemebrship name strings used for this option.
" - }, - "OptionSettings":{ - "shape":"OptionSettingsList", - "documentation":"The option settings to include in an option group.
" - } - }, - "documentation":"A list of all available options
" - }, - "OptionConfigurationList":{ - "type":"list", - "member":{ - "shape":"OptionConfiguration", - "locationName":"OptionConfiguration" - } - }, - "OptionGroup":{ - "type":"structure", - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the option group.
" - }, - "OptionGroupDescription":{ - "shape":"String", - "documentation":"Provides the description of the option group.
" - }, - "EngineName":{ - "shape":"String", - "documentation":"Engine name that this option group can be applied to.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Indicates the major engine version associated with this option group.
" - }, - "Options":{ - "shape":"OptionsList", - "documentation":"Indicates what options are available in the option group.
" - }, - "AllowsVpcAndNonVpcInstanceMemberships":{ - "shape":"Boolean", - "documentation":"Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
" - } - }, - "wrapper":true, - "documentation":"" - }, - "OptionGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OptionGroupAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group you are trying to create already exists.
" - }, - "OptionGroupMembership":{ - "type":"structure", - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group that the instance belongs to.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).
" - } - }, - "documentation":"Provides information on the option groups the DB instance is a member of.
" - }, - "OptionGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"OptionGroupMembership", - "locationName":"OptionGroupMembership" - } - }, - "OptionGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - "OptionGroupOption":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the option.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the option.
" - }, - "EngineName":{ - "shape":"String", - "documentation":"Engine name that this option can be applied to.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Indicates the major engine version that the option is available for.
" - }, - "MinimumRequiredMinorEngineVersion":{ - "shape":"String", - "documentation":"The minimum required engine version for the option to be applied.
" - }, - "PortRequired":{ - "shape":"Boolean", - "documentation":"Specifies whether the option requires a port.
" - }, - "DefaultPort":{ - "shape":"IntegerOptional", - "documentation":"If the option requires a port, specifies the default port for the option.
" - }, - "OptionsDependedOn":{ - "shape":"OptionsDependedOn", - "documentation":"List of all options that are prerequisites for this option.
" - }, - "Persistent":{ - "shape":"Boolean", - "documentation":"A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.
" - }, - "Permanent":{ - "shape":"Boolean", - "documentation":"A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.
" - }, - "OptionGroupOptionSettings":{ - "shape":"OptionGroupOptionSettingsList", - "documentation":"Specifies the option settings that are available (and the default value) for each option in an option group.
" - } - }, - "documentation":"Available option.
" - }, - "OptionGroupOptionSetting":{ - "type":"structure", - "members":{ - "SettingName":{ - "shape":"String", - "documentation":"The name of the option group option.
" - }, - "SettingDescription":{ - "shape":"String", - "documentation":"The description of the option group option.
" - }, - "DefaultValue":{ - "shape":"String", - "documentation":"The default value for the option group option.
" - }, - "ApplyType":{ - "shape":"String", - "documentation":"The DB engine specific parameter type for the option group option.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"Indicates the acceptable values for the option group option.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":"Boolean value where true indicates that this option group option can be changed from the default value.
" - } - }, - "documentation":"option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
" - }, - "OptionGroupOptionSettingsList":{ - "type":"list", - "member":{ - "shape":"OptionGroupOptionSetting", - "locationName":"OptionGroupOptionSetting" - } - }, - "OptionGroupOptionsList":{ - "type":"list", - "member":{ - "shape":"OptionGroupOption", - "locationName":"OptionGroupOption" - }, - "documentation":"List of available option group options.
" - }, - "OptionGroupOptionsMessage":{ - "type":"structure", - "members":{ - "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, - "Marker":{ - "shape":"String", - "documentation":"An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "OptionGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OptionGroupQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The quota of 20 option groups was exceeded for this AWS account.
" - }, - "OptionGroups":{ - "type":"structure", - "members":{ - "OptionGroupsList":{ - "shape":"OptionGroupsList", - "documentation":"List of option groups.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
List of option groups.
" - }, - "OptionGroupsList":{ - "type":"list", - "member":{ - "shape":"OptionGroup", - "locationName":"OptionGroup" - } - }, - "OptionNamesList":{ - "type":"list", - "member":{"shape":"String"} - }, - "OptionSetting":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the option that has settings that you can set.
" - }, - "Value":{ - "shape":"String", - "documentation":"The current value of the option setting.
" - }, - "DefaultValue":{ - "shape":"String", - "documentation":"The default value of the option setting.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the option setting.
" - }, - "ApplyType":{ - "shape":"String", - "documentation":"The DB engine specific parameter type.
" - }, - "DataType":{ - "shape":"String", - "documentation":"The data type of the option setting.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"The allowed values of the option setting.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":"A Boolean value that, when true, indicates the option setting can be modified from the default.
" - }, - "IsCollection":{ - "shape":"Boolean", - "documentation":"Indicates if the option setting is part of a collection.
" - } - }, - "documentation":"Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
" - }, - "OptionSettingConfigurationList":{ - "type":"list", - "member":{ - "shape":"OptionSetting", - "locationName":"OptionSetting" - } - }, - "OptionSettingsList":{ - "type":"list", - "member":{ - "shape":"OptionSetting", - "locationName":"OptionSetting" - } - }, - "OptionsDependedOn":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"OptionName" - } - }, - "OptionsList":{ - "type":"list", - "member":{ - "shape":"Option", - "locationName":"Option" - } - }, - "OrderableDBInstanceOption":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"The engine type of the orderable DB instance.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The engine version of the orderable DB instance.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance Class for the orderable DB instance
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"The license model for the orderable DB instance.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZoneList", - "documentation":"A list of availability zones for the orderable DB instance.
" - }, - "MultiAZCapable":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance is multi-AZ capable.
" - }, - "ReadReplicaCapable":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance can have a read replica.
" - }, - "Vpc":{ - "shape":"Boolean", - "documentation":"Indicates whether this is a VPC orderable DB instance.
" - }, - "StorageType":{ - "shape":"String", - "documentation":"The storage type for this orderable DB instance.
" - }, - "SupportsIops":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance supports provisioned IOPS.
" - } - }, - "wrapper":true, - "documentation":"Contains a list of available options for a DB instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
" - }, - "OrderableDBInstanceOptionsList":{ - "type":"list", - "member":{ - "shape":"OrderableDBInstanceOption", - "locationName":"OrderableDBInstanceOption" - } - }, - "OrderableDBInstanceOptionsMessage":{ - "type":"structure", - "members":{ - "OrderableDBInstanceOptions":{ - "shape":"OrderableDBInstanceOptionsList", - "documentation":"An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
" - }, - "Parameter":{ - "type":"structure", - "members":{ - "ParameterName":{ - "shape":"String", - "documentation":"Specifies the name of the parameter.
" - }, - "ParameterValue":{ - "shape":"String", - "documentation":"Specifies the value of the parameter.
" - }, - "Description":{ - "shape":"String", - "documentation":"Provides a description of the parameter.
" - }, - "Source":{ - "shape":"String", - "documentation":"Indicates the source of the parameter value.
" - }, - "ApplyType":{ - "shape":"String", - "documentation":"Specifies the engine specific parameters type.
" - }, - "DataType":{ - "shape":"String", - "documentation":"Specifies the valid data type for the parameter.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"Specifies the valid range of values for the parameter.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":" Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
" - }, - "ApplyMethod":{ - "shape":"ApplyMethod", - "documentation":"Indicates when to apply parameter updates.
" - } - }, - "documentation":"This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
" - }, - "ParametersList":{ - "type":"list", - "member":{ - "shape":"Parameter", - "locationName":"Parameter" - } - }, - "PendingModifiedValues":{ - "type":"structure", - "members":{ - "DBInstanceClass":{ - "shape":"String", - "documentation":" Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB instance.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"Specifies the pending port for the DB instance.
" - }, - "BackupRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"Specifies the pending number of days for which automated backups are retained.
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":"Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"Indicates the database engine version.
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
" - }, - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":" Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
Specifies storage type to be associated with the DB instance.
" - } - }, - "documentation":"This data type is used as a response element in the ModifyDBInstance action.
" - }, - "PointInTimeRestoreNotEnabledFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"PointInTimeRestoreNotEnabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
" - }, - "PromoteReadReplicaMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Example:
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
" - }, - "ProvisionedIopsNotAvailableInAZFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
Provisioned IOPS not available in the specified Availability Zone.
" - }, - "PurchaseReservedDBInstancesOfferingMessage":{ - "type":"structure", - "required":["ReservedDBInstancesOfferingId"], - "members":{ - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
" - }, - "ReservedDBInstanceId":{ - "shape":"String", - "documentation":"Customer-specified identifier to track this reservation.
Example: myreservationID
" - }, - "DBInstanceCount":{ - "shape":"IntegerOptional", - "documentation":"The number of instances to reserve.
Default: 1
" - }, - "ReadReplicaDBInstanceIdentifierList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ReadReplicaDBInstanceIdentifier" - } - }, - "RebootDBInstanceMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
" - }, - "RecurringCharge":{ - "type":"structure", - "members":{ - "RecurringChargeAmount":{ - "shape":"Double", - "documentation":"
The amount of the recurring charge.
" - }, - "RecurringChargeFrequency":{ - "shape":"String", - "documentation":"The frequency of the recurring charge.
" - } - }, - "wrapper":true, - "documentation":"This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
" - }, - "RecurringChargeList":{ - "type":"list", - "member":{ - "shape":"RecurringCharge", - "locationName":"RecurringCharge" - } - }, - "RemoveSourceIdentifierFromSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SourceIdentifier" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the RDS event notification subscription you want to remove a source identifier from.
" - }, - "SourceIdentifier":{ - "shape":"String", - "documentation":"The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
" - } - }, - "documentation":"" - }, - "RemoveTagsFromResourceMessage":{ - "type":"structure", - "required":[ - "ResourceName", - "TagKeys" - ], - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":"The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" - }, - "TagKeys":{ - "shape":"KeyList", - "documentation":"The tag key (name) of the tag to be removed.
" - } - }, - "documentation":"" - }, - "ReservedDBInstance":{ - "type":"structure", - "members":{ - "ReservedDBInstanceId":{ - "shape":"String", - "documentation":"The unique identifier for the reservation.
" - }, - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class for the reserved DB instance.
" - }, - "StartTime":{ - "shape":"TStamp", - "documentation":"The time the reservation started.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the reservation in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed price charged for this reserved DB instance.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly price charged for this reserved DB instance.
" - }, - "CurrencyCode":{ - "shape":"String", - "documentation":"The currency code for the reserved DB instance.
" - }, - "DBInstanceCount":{ - "shape":"Integer", - "documentation":"The number of reserved DB instances.
" - }, - "ProductDescription":{ - "shape":"String", - "documentation":"The description of the reserved DB instance.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type of this reserved DB instance.
" - }, - "MultiAZ":{ - "shape":"Boolean", - "documentation":"Indicates if the reservation applies to Multi-AZ deployments.
" - }, - "State":{ - "shape":"String", - "documentation":"The state of the reserved DB instance.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring price charged to run this reserved DB instance.
" - } - }, - "wrapper":true, - "documentation":"This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
" - }, - "ReservedDBInstanceAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstanceAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a reservation with the given identifier.
" - }, - "ReservedDBInstanceList":{ - "type":"list", - "member":{ - "shape":"ReservedDBInstance", - "locationName":"ReservedDBInstance" - } - }, - "ReservedDBInstanceMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of reserved DB instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeReservedDBInstances action.
" - }, - "ReservedDBInstanceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified reserved DB Instance not found.
" - }, - "ReservedDBInstanceQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would exceed the user's DB Instance quota.
" - }, - "ReservedDBInstancesOffering":{ - "type":"structure", - "members":{ - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class for the reserved DB instance.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the offering in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed price charged for this offering.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly price charged for this offering.
" - }, - "CurrencyCode":{ - "shape":"String", - "documentation":"The currency code for the reserved DB instance offering.
" - }, - "ProductDescription":{ - "shape":"String", - "documentation":"The database engine used by the offering.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type.
" - }, - "MultiAZ":{ - "shape":"Boolean", - "documentation":"Indicates if the offering applies to Multi-AZ deployments.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring price charged to run this reserved DB instance.
" - } - }, - "wrapper":true, - "documentation":"This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
" - }, - "ReservedDBInstancesOfferingList":{ - "type":"list", - "member":{ - "shape":"ReservedDBInstancesOffering", - "locationName":"ReservedDBInstancesOffering" - } - }, - "ReservedDBInstancesOfferingMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of reserved DB instance offerings.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
" - }, - "ReservedDBInstancesOfferingNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstancesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - }, - "ResetDBParameterGroupMessage":{ - "type":"structure", - "required":["DBParameterGroupName"], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group.
Constraints:
Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
Default: true
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
" - }, - "RestoreDBInstanceFromDBSnapshotMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "DBSnapshotIdentifier" - ], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":"Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "Tags":{"shape":"TagList"}, - "StorageType":{ - "shape":"String", - "documentation":"Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "RestoreDBInstanceToPointInTimeMessage":{ - "type":"structure", - "required":[ - "SourceDBInstanceIdentifier", - "TargetDBInstanceIdentifier" - ], - "members":{ - "SourceDBInstanceIdentifier":{ - "shape":"String", - "documentation":"
The identifier of the source DB instance from which to restore.
Constraints:
The name of the new database instance to be created.
Constraints:
The date and time to restore from.
Valid Values: Value must be a UTC time
Constraints:
Example: 2009-09-07T23:45:00Z
Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: The same DBInstanceClass as the original DB instance.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":"Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
" - }, - "Engine":{ - "shape":"String", - "documentation":"The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "Tags":{"shape":"TagList"}, - "StorageType":{ - "shape":"String", - "documentation":"Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "RevokeDBSecurityGroupIngressMessage":{ - "type":"structure", - "required":["DBSecurityGroupName"], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"
The name of the DB security group to revoke ingress from.
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":" The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
" - }, - "SNSInvalidTopicFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
SNS has responded that there is a problem with the SND topic specified.
" - }, - "SNSNoAuthorizationFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the SNS topic ARN.
" - }, - "SNSTopicArnNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The SNS topic ARN does not exist.
" - }, - "SnapshotQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - }, - "SourceIdsList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SourceId" - } - }, - "SourceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - }, - "SourceType":{ - "type":"string", - "enum":[ - "db-instance", - "db-parameter-group", - "db-security-group", - "db-snapshot" - ] - }, - "StorageQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - "StorageTypeNotSupportedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - "String":{"type":"string"}, - "Subnet":{ - "type":"structure", - "members":{ - "SubnetIdentifier":{ - "shape":"String", - "documentation":"Specifies the identifier of the subnet.
" - }, - "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, - "SubnetStatus":{ - "shape":"String", - "documentation":"Specifies the status of the subnet.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeDBSubnetGroups action.
" - }, - "SubnetAlreadyInUse":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubnetAlreadyInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is already in use in the Availability Zone.
" - }, - "SubnetIdentifierList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SubnetIdentifier" - } - }, - "SubnetList":{ - "type":"list", - "member":{ - "shape":"Subnet", - "locationName":"Subnet" - } - }, - "SubscriptionAlreadyExistFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionAlreadyExist", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied subscription name already exists.
" - }, - "SubscriptionCategoryNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied category does not exist.
" - }, - "SubscriptionNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - "SupportedCharacterSetsList":{ - "type":"list", - "member":{ - "shape":"CharacterSet", - "locationName":"CharacterSet" - } - }, - "TStamp":{"type":"timestamp"}, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
" - }, - "Value":{ - "shape":"String", - "documentation":"A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
" - } - }, - "documentation":"Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" - }, - "TagList":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"Tag" - }, - "documentation":"A list of tags.
" - }, - "TagListMessage":{ - "type":"structure", - "members":{ - "TagList":{ - "shape":"TagList", - "documentation":"List of tags returned by the ListTagsForResource operation.
" - } - }, - "documentation":"" - }, - "VpcSecurityGroupIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpcSecurityGroupId" - } - }, - "VpcSecurityGroupMembership":{ - "type":"structure", - "members":{ - "VpcSecurityGroupId":{ - "shape":"String", - "documentation":"The name of the VPC security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the VPC security group.
" - } - }, - "documentation":"This data type is used as a response element for queries on VPC security group membership.
" - }, - "VpcSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"VpcSecurityGroupMembership", - "locationName":"VpcSecurityGroupMembership" - } - }, - "AddSourceIdentifierToSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "AuthorizeDBSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "DBSecurityGroup":{"shape":"DBSecurityGroup"} - } - }, - "CopyDBParameterGroupResult":{ - "type":"structure", - "members":{ - "DBParameterGroup":{"shape":"DBParameterGroup"} - } - }, - "CopyDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBSnapshot":{"shape":"DBSnapshot"} - } - }, - "CopyOptionGroupResult":{ - "type":"structure", - "members":{ - "OptionGroup":{"shape":"OptionGroup"} - } - }, - "CreateDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "CreateDBInstanceReadReplicaResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "CreateDBParameterGroupResult":{ - "type":"structure", - "members":{ - "DBParameterGroup":{"shape":"DBParameterGroup"} - } - }, - "CreateDBSecurityGroupResult":{ - "type":"structure", - "members":{ - "DBSecurityGroup":{"shape":"DBSecurityGroup"} - } - }, - "CreateDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBSnapshot":{"shape":"DBSnapshot"} - } - }, - "CreateDBSubnetGroupResult":{ - "type":"structure", - "members":{ - "DBSubnetGroup":{"shape":"DBSubnetGroup"} - } - }, - "CreateEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "CreateOptionGroupResult":{ - "type":"structure", - "members":{ - "OptionGroup":{"shape":"OptionGroup"} - } - }, - "DeleteDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "DeleteDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBSnapshot":{"shape":"DBSnapshot"} - } - }, - "DeleteEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "DescribeEngineDefaultParametersResult":{ - "type":"structure", - "members":{ - "EngineDefaults":{"shape":"EngineDefaults"} - } - }, - "ModifyDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "ModifyDBSubnetGroupResult":{ - "type":"structure", - "members":{ - "DBSubnetGroup":{"shape":"DBSubnetGroup"} - } - }, - "ModifyEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "ModifyOptionGroupResult":{ - "type":"structure", - "members":{ - "OptionGroup":{"shape":"OptionGroup"} - } - }, - "PromoteReadReplicaResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "PurchaseReservedDBInstancesOfferingResult":{ - "type":"structure", - "members":{ - "ReservedDBInstance":{"shape":"ReservedDBInstance"} - } - }, - "RebootDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "RemoveSourceIdentifierFromSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "RestoreDBInstanceFromDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "RestoreDBInstanceToPointInTimeResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "RevokeDBSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "DBSecurityGroup":{"shape":"DBSecurityGroup"} - } - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-09-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-09-01.paginators.json deleted file mode 100644 index 76c4f3a119..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-09-01.paginators.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "pagination": { - "DescribeDBEngineVersions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBEngineVersions" - }, - "DescribeDBInstances": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBInstances" - }, - "DescribeDBLogFiles": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DescribeDBLogFiles" - }, - "DescribeDBParameterGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBParameterGroups" - }, - "DescribeDBParameters": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Parameters" - }, - "DescribeDBSecurityGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBSecurityGroups" - }, - "DescribeDBSnapshots": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBSnapshots" - }, - "DescribeDBSubnetGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBSubnetGroups" - }, - "DescribeEngineDefaultParameters": { - "input_token": "Marker", - "output_token": "EngineDefaults.Marker", - "limit_key": "MaxRecords", - "result_key": "EngineDefaults.Parameters" - }, - "DescribeEventSubscriptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "EventSubscriptionsList" - }, - "DescribeEvents": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Events" - }, - "DescribeOptionGroupOptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OptionGroupOptions" - }, - "DescribeOptionGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OptionGroupsList" - }, - "DescribeOrderableDBInstanceOptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OrderableDBInstanceOptions" - }, - "DescribeReservedDBInstances": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedDBInstances" - }, - "DescribeReservedDBInstancesOfferings": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedDBInstancesOfferings" - }, - "DownloadDBLogFilePortion": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "NumberOfLines", - "more_results": "AdditionalDataPending", - "result_key": "LogFileData" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-09-01.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-09-01.waiters.json deleted file mode 100644 index b01500797d..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-09-01.waiters.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "version": 2, - "waiters": { - "DBInstanceAvailable": { - "delay": 30, - "operation": "DescribeDBInstances", - "maxAttempts": 60, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "failed", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-restore", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-parameters", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-parameters", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-restore", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - } - ] - }, - "DBInstanceDeleted": { - "delay": 30, - "operation": "DescribeDBInstances", - "maxAttempts": 60, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "creating", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "modifying", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "rebooting", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "resetting-master-credentials", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.normal.json deleted file mode 100644 index d6cd5862a2..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.normal.json +++ /dev/null @@ -1,7217 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-10-31", - "endpointPrefix":"rds", - "serviceAbbreviation":"Amazon RDS", - "serviceFullName":"Amazon Relational Database Service", - "signatureVersion":"v4", - "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/", - "protocol":"query" - }, - "documentation":"Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.
", - "operations":{ - "AddSourceIdentifierToSubscription":{ - "name":"AddSourceIdentifierToSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddSourceIdentifierToSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"AddSourceIdentifierToSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"AddSourceIdentifierToSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - } - ], - "documentation":"Adds a source identifier to an existing RDS event notification subscription.
" - }, - "AddTagsToResource":{ - "name":"AddTagsToResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddTagsToResourceMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
" - }, - "ApplyPendingMaintenanceAction":{ - "name":"ApplyPendingMaintenanceAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ApplyPendingMaintenanceActionMessage", - "documentation":"" - }, - "output":{ - "shape":"ApplyPendingMaintenanceActionResult", - "wrapper":true, - "documentation":"Describes the pending maintenance actions for a resource.
", - "resultWrapper":"ApplyPendingMaintenanceActionResult" - }, - "errors":[ - { - "shape":"ResourceNotFoundFault", - "error":{ - "code":"ResourceNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Resource ID was not found.
" - } - ], - "documentation":"Applies a pending maintenance action to a resource.
" - }, - "AuthorizeDBSecurityGroupIngress":{ - "name":"AuthorizeDBSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AuthorizeDBSecurityGroupIngressMessage", - "documentation":"" - }, - "output":{ - "shape":"AuthorizeDBSecurityGroupIngressResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", - "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - }, - { - "shape":"AuthorizationAlreadyExistsFault", - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
" - }, - { - "shape":"AuthorizationQuotaExceededFault", - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB security group authorization quota has been reached.
" - } - ], - "documentation":"Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
" - }, - "CopyDBParameterGroup":{ - "name":"CopyDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyDBParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyDBParameterGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", - "resultWrapper":"CopyDBParameterGroupResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"DBParameterGroupAlreadyExistsFault", - "error":{ - "code":"DBParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB parameter group with the same name exists.
" - }, - { - "shape":"DBParameterGroupQuotaExceededFault", - "error":{ - "code":"DBParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
" - } - ], - "documentation":"Copies the specified DB parameter group.
" - }, - "CopyDBSnapshot":{ - "name":"CopyDBSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyDBSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", - "resultWrapper":"CopyDBSnapshotResult" - }, - "errors":[ - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - }, - { - "shape":"InvalidDBSnapshotStateFault", - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - } - ], - "documentation":"Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.
" - }, - "CopyOptionGroup":{ - "name":"CopyOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyOptionGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyOptionGroupResult", - "wrapper":true, - "documentation":"
", - "resultWrapper":"CopyOptionGroupResult" - }, - "errors":[ - { - "shape":"OptionGroupAlreadyExistsFault", - "error":{ - "code":"OptionGroupAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group you are trying to create already exists.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"OptionGroupQuotaExceededFault", - "error":{ - "code":"OptionGroupQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota of 20 option groups was exceeded for this AWS account.
" - } - ], - "documentation":"Copies the specified option group.
" - }, - "CreateDBInstance":{ - "name":"CreateDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"CreateDBInstanceResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - { - "shape":"KMSKeyNotAccessibleFault", - "error":{ - "code":"KMSKeyNotAccessibleFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error accessing KMS key.
" - } - ], - "documentation":"Creates a new DB instance.
" - }, - "CreateDBInstanceReadReplica":{ - "name":"CreateDBInstanceReadReplica", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, - "output":{ - "shape":"CreateDBInstanceReadReplicaResult", - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"CreateDBInstanceReadReplicaResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"DBSubnetGroupNotAllowedFault", - "error":{ - "code":"DBSubnetGroupNotAllowedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
" - }, - { - "shape":"InvalidDBSubnetGroupFault", - "error":{ - "code":"InvalidDBSubnetGroupFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"KMSKeyNotAccessibleFault", - "error":{ - "code":"KMSKeyNotAccessibleFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error accessing KMS key.
" - } - ], - "documentation":"Creates a DB instance that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
" - }, - "output":{ - "shape":"CreateDBParameterGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", - "resultWrapper":"CreateDBParameterGroupResult" - }, - "errors":[ - { - "shape":"DBParameterGroupQuotaExceededFault", - "error":{ - "code":"DBParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
" - }, - { - "shape":"DBParameterGroupAlreadyExistsFault", - "error":{ - "code":"DBParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB parameter group with the same name exists.
" - } - ], - "documentation":"Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
" - }, - "output":{ - "shape":"CreateDBSecurityGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", - "resultWrapper":"CreateDBSecurityGroupResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupAlreadyExistsFault", - "error":{ - "code":"DBSecurityGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group with the name specified in DBSecurityGroupName already exists.
" - }, - { - "shape":"DBSecurityGroupQuotaExceededFault", - "error":{ - "code":"QuotaExceeded.DBSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB security groups.
" - }, - { - "shape":"DBSecurityGroupNotSupportedFault", - "error":{ - "code":"DBSecurityGroupNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group is not allowed for this action.
" - } - ], - "documentation":"Creates a new DB security group. DB security groups control access to a DB instance.
" - }, - "CreateDBSnapshot":{ - "name":"CreateDBSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDBSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", - "resultWrapper":"CreateDBSnapshotResult" - }, - "errors":[ - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - } - ], - "documentation":"Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
" - }, - "CreateDBSubnetGroup":{ - "name":"CreateDBSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateDBSubnetGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateDBSubnetGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", - "resultWrapper":"CreateDBSubnetGroupResult" - }, - "errors":[ - { - "shape":"DBSubnetGroupAlreadyExistsFault", - "error":{ - "code":"DBSubnetGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName is already used by an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupQuotaExceededFault", - "error":{ - "code":"DBSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB subnet groups.
" - }, - { - "shape":"DBSubnetQuotaExceededFault", - "error":{ - "code":"DBSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - } - ], - "documentation":"Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
" - }, - "CreateEventSubscription":{ - "name":"CreateEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateEventSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"CreateEventSubscriptionResult" - }, - "errors":[ - { - "shape":"EventSubscriptionQuotaExceededFault", - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You have reached the maximum number of event subscriptions.
" - }, - { - "shape":"SubscriptionAlreadyExistFault", - "error":{ - "code":"SubscriptionAlreadyExist", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied subscription name already exists.
" - }, - { - "shape":"SNSInvalidTopicFault", - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SNS has responded that there is a problem with the SND topic specified.
" - }, - { - "shape":"SNSNoAuthorizationFault", - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the SNS topic ARN.
" - }, - { - "shape":"SNSTopicArnNotFoundFault", - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The SNS topic ARN does not exist.
" - }, - { - "shape":"SubscriptionCategoryNotFoundFault", - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied category does not exist.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - } - ], - "documentation":"Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
" - }, - "CreateOptionGroup":{ - "name":"CreateOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateOptionGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateOptionGroupResult", - "wrapper":true, - "documentation":"", - "resultWrapper":"CreateOptionGroupResult" - }, - "errors":[ - { - "shape":"OptionGroupAlreadyExistsFault", - "error":{ - "code":"OptionGroupAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group you are trying to create already exists.
" - }, - { - "shape":"OptionGroupQuotaExceededFault", - "error":{ - "code":"OptionGroupQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota of 20 option groups was exceeded for this AWS account.
" - } - ], - "documentation":"Creates a new option group. You can create up to 20 option groups.
" - }, - "DeleteDBInstance":{ - "name":"DeleteDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"DeleteDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"DeleteDBInstanceResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBSnapshotAlreadyExistsFault", - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - { - "shape":"SnapshotQuotaExceededFault", - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - } - ], - "documentation":"The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.
" - }, - "errors":[ - { - "shape":"InvalidDBParameterGroupStateFault", - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The DB parameter group cannot be deleted because it is in use.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":"Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
" - }, - "errors":[ - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The state of the DB security group does not allow deletion.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - } - ], - "documentation":"Deletes a DB security group.
" - }, - "output":{ - "shape":"DeleteDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", - "resultWrapper":"DeleteDBSnapshotResult" - }, - "errors":[ - { - "shape":"InvalidDBSnapshotStateFault", - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
available state to be deleted." - }, - "errors":[ - { - "shape":"InvalidDBSubnetGroupStateFault", - "error":{ - "code":"InvalidDBSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The DB subnet group cannot be deleted because it is in use.
" - }, - { - "shape":"InvalidDBSubnetStateFault", - "error":{ - "code":"InvalidDBSubnetStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is not in the available state.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - } - ], - "documentation":"Deletes a DB subnet group.
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"DeleteEventSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"InvalidEventSubscriptionStateFault", - "error":{ - "code":"InvalidEventSubscriptionState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This error can occur if someone else is modifying a subscription. You should retry the action.
" - } - ], - "documentation":"Deletes an RDS event notification subscription.
" - }, - "DeleteOptionGroup":{ - "name":"DeleteOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteOptionGroupMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"
The specified option group could not be found.
" - }, - { - "shape":"InvalidOptionGroupStateFault", - "error":{ - "code":"InvalidOptionGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The option group is not in the available state.
" - } - ], - "documentation":"Deletes an existing option group.
" - }, - "DescribeDBEngineVersions":{ - "name":"DescribeDBEngineVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDBEngineVersionsMessage"}, - "output":{ - "shape":"DBEngineVersionMessage", - "documentation":"Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", - "resultWrapper":"DescribeDBEngineVersionsResult" - }, - "documentation":"Returns a list of the available DB engines.
" - }, - "DescribeDBInstances":{ - "name":"DescribeDBInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBInstancesMessage", - "documentation":"" - }, - "output":{ - "shape":"DBInstanceMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBInstances action.
", - "resultWrapper":"DescribeDBInstancesResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Returns information about provisioned RDS instances. This API supports pagination.
" - }, - "DescribeDBLogFiles":{ - "name":"DescribeDBLogFiles", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBLogFilesMessage", - "documentation":"" - }, - "output":{ - "shape":"DescribeDBLogFilesResponse", - "documentation":"
The response from a call to DescribeDBLogFiles.
", - "resultWrapper":"DescribeDBLogFilesResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Returns a list of DB log files for the DB instance.
" - }, - "DescribeDBParameterGroups":{ - "name":"DescribeDBParameterGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBParameterGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"DBParameterGroupsMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", - "resultWrapper":"DescribeDBParameterGroupsResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":" Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Contains the result of a successful invocation of the DescribeDBParameters action.
", - "resultWrapper":"DescribeDBParametersResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":"Returns the detailed parameter list for a particular DB parameter group.
" - }, - "DescribeDBSecurityGroups":{ - "name":"DescribeDBSecurityGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBSecurityGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"DBSecurityGroupMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", - "resultWrapper":"DescribeDBSecurityGroupsResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - } - ], - "documentation":" Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
" - }, - "output":{ - "shape":"DBSnapshotMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBSnapshots action.
", - "resultWrapper":"DescribeDBSnapshotsResult" - }, - "errors":[ - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Returns information about DB snapshots. This API supports pagination.
" - }, - "DescribeDBSubnetGroups":{ - "name":"DescribeDBSubnetGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDBSubnetGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"DBSubnetGroupMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", - "resultWrapper":"DescribeDBSubnetGroupsResult" - }, - "errors":[ - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - } - ], - "documentation":"Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
" - }, - "DescribeEngineDefaultParameters":{ - "name":"DescribeEngineDefaultParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEngineDefaultParametersMessage", - "documentation":"" - }, - "output":{ - "shape":"DescribeEngineDefaultParametersResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", - "resultWrapper":"DescribeEngineDefaultParametersResult" - }, - "documentation":"Returns the default engine and system parameter information for the specified database engine.
" - }, - "DescribeEventCategories":{ - "name":"DescribeEventCategories", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventCategoriesMessage", - "documentation":"" - }, - "output":{ - "shape":"EventCategoriesMessage", - "documentation":"Data returned from the DescribeEventCategories action.
", - "resultWrapper":"DescribeEventCategoriesResult" - }, - "documentation":"Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
" - }, - "DescribeEventSubscriptions":{ - "name":"DescribeEventSubscriptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventSubscriptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"EventSubscriptionsMessage", - "documentation":"Data returned by the DescribeEventSubscriptions action.
", - "resultWrapper":"DescribeEventSubscriptionsResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - } - ], - "documentation":"Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
" - }, - "DescribeEvents":{ - "name":"DescribeEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventsMessage", - "documentation":"" - }, - "output":{ - "shape":"EventsMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeEvents action.
", - "resultWrapper":"DescribeEventsResult" - }, - "documentation":"Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
" - }, - "DescribeOptionGroupOptions":{ - "name":"DescribeOptionGroupOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOptionGroupOptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"OptionGroupOptionsMessage", - "documentation":"
", - "resultWrapper":"DescribeOptionGroupOptionsResult" - }, - "documentation":"
Describes all available options.
" - }, - "DescribeOptionGroups":{ - "name":"DescribeOptionGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOptionGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"OptionGroups", - "documentation":"
List of option groups.
", - "resultWrapper":"DescribeOptionGroupsResult" - }, - "errors":[ - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - } - ], - "documentation":"Describes the available option groups.
" - }, - "DescribeOrderableDBInstanceOptions":{ - "name":"DescribeOrderableDBInstanceOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOrderableDBInstanceOptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"OrderableDBInstanceOptionsMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", - "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" - }, - "documentation":"Returns a list of orderable DB instance options for the specified engine.
" - }, - "DescribePendingMaintenanceActions":{ - "name":"DescribePendingMaintenanceActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribePendingMaintenanceActionsMessage", - "documentation":"" - }, - "output":{ - "shape":"PendingMaintenanceActionsMessage", - "documentation":"Data returned from the DescribePendingMaintenanceActions action.
", - "resultWrapper":"DescribePendingMaintenanceActionsResult" - }, - "errors":[ - { - "shape":"ResourceNotFoundFault", - "error":{ - "code":"ResourceNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Resource ID was not found.
" - } - ], - "documentation":"Returns a list of resources (for example, DB Instances) that have at least one pending maintenance action.
" - }, - "DescribeReservedDBInstances":{ - "name":"DescribeReservedDBInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedDBInstancesMessage", - "documentation":"" - }, - "output":{ - "shape":"ReservedDBInstanceMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", - "resultWrapper":"DescribeReservedDBInstancesResult" - }, - "errors":[ - { - "shape":"ReservedDBInstanceNotFoundFault", - "error":{ - "code":"ReservedDBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified reserved DB Instance not found.
" - } - ], - "documentation":"Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
" - }, - "DescribeReservedDBInstancesOfferings":{ - "name":"DescribeReservedDBInstancesOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedDBInstancesOfferingsMessage", - "documentation":"" - }, - "output":{ - "shape":"ReservedDBInstancesOfferingMessage", - "documentation":"
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", - "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" - }, - "errors":[ - { - "shape":"ReservedDBInstancesOfferingNotFoundFault", - "error":{ - "code":"ReservedDBInstancesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - } - ], - "documentation":"Lists available reserved DB instance offerings.
" - }, - "DownloadDBLogFilePortion":{ - "name":"DownloadDBLogFilePortion", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DownloadDBLogFilePortionMessage", - "documentation":"" - }, - "output":{ - "shape":"DownloadDBLogFilePortionDetails", - "documentation":"
This data type is used as a response element to DownloadDBLogFilePortion.
", - "resultWrapper":"DownloadDBLogFilePortionResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Downloads all or a portion of the specified log file.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListTagsForResourceMessage", - "documentation":"" - }, - "output":{ - "shape":"TagListMessage", - "documentation":"", - "resultWrapper":"ListTagsForResourceResult" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
" - }, - "ModifyDBInstance":{ - "name":"ModifyDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"ModifyDBInstanceResult" - }, - "errors":[ - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - }, - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"DBUpgradeDependencyFailureFault", - "error":{ - "code":"DBUpgradeDependencyFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB upgrade failed because a resource the DB depends on could not be modified.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - } - ], - "documentation":"Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
" - }, - "ModifyDBParameterGroup":{ - "name":"ModifyDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyDBParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"DBParameterGroupNameMessage", - "documentation":"
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", - "resultWrapper":"ModifyDBParameterGroupResult" - }, - "errors":[ - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - { - "shape":"InvalidDBParameterGroupStateFault", - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB parameter group cannot be deleted because it is in use.
" - } - ], - "documentation":" Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
" - }, - "output":{ - "shape":"ModifyDBSubnetGroupResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", - "resultWrapper":"ModifyDBSubnetGroupResult" - }, - "errors":[ - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetQuotaExceededFault", - "error":{ - "code":"DBSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
" - }, - { - "shape":"SubnetAlreadyInUse", - "error":{ - "code":"SubnetAlreadyInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is already in use in the Availability Zone.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - } - ], - "documentation":"Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
" - }, - "ModifyEventSubscription":{ - "name":"ModifyEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyEventSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"ModifyEventSubscriptionResult" - }, - "errors":[ - { - "shape":"EventSubscriptionQuotaExceededFault", - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You have reached the maximum number of event subscriptions.
" - }, - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"SNSInvalidTopicFault", - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SNS has responded that there is a problem with the SND topic specified.
" - }, - { - "shape":"SNSNoAuthorizationFault", - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the SNS topic ARN.
" - }, - { - "shape":"SNSTopicArnNotFoundFault", - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The SNS topic ARN does not exist.
" - }, - { - "shape":"SubscriptionCategoryNotFoundFault", - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied category does not exist.
" - } - ], - "documentation":"Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" - }, - "ModifyOptionGroup":{ - "name":"ModifyOptionGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyOptionGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyOptionGroupResult", - "wrapper":true, - "documentation":"
", - "resultWrapper":"ModifyOptionGroupResult" - }, - "errors":[ - { - "shape":"InvalidOptionGroupStateFault", - "error":{ - "code":"InvalidOptionGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group is not in the available state.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - } - ], - "documentation":"Modifies an existing option group.
" - }, - "PromoteReadReplica":{ - "name":"PromoteReadReplica", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PromoteReadReplicaMessage", - "documentation":"" - }, - "output":{ - "shape":"PromoteReadReplicaResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"PromoteReadReplicaResult" - }, - "errors":[ - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
" - }, - "output":{ - "shape":"PurchaseReservedDBInstancesOfferingResult", - "wrapper":true, - "documentation":"
This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", - "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" - }, - "errors":[ - { - "shape":"ReservedDBInstancesOfferingNotFoundFault", - "error":{ - "code":"ReservedDBInstancesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - }, - { - "shape":"ReservedDBInstanceAlreadyExistsFault", - "error":{ - "code":"ReservedDBInstanceAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a reservation with the given identifier.
" - }, - { - "shape":"ReservedDBInstanceQuotaExceededFault", - "error":{ - "code":"ReservedDBInstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would exceed the user's DB Instance quota.
" - } - ], - "documentation":"Purchases a reserved DB instance offering.
" - }, - "RebootDBInstance":{ - "name":"RebootDBInstance", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RebootDBInstanceMessage", - "documentation":"" - }, - "output":{ - "shape":"RebootDBInstanceResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"RebootDBInstanceResult" - }, - "errors":[ - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - } - ], - "documentation":"Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
" - }, - "RemoveSourceIdentifierFromSubscription":{ - "name":"RemoveSourceIdentifierFromSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveSourceIdentifierFromSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"RemoveSourceIdentifierFromSubscriptionResult", - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", - "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - } - ], - "documentation":"Removes a source identifier from an existing RDS event notification subscription.
" - }, - "RemoveTagsFromResource":{ - "name":"RemoveTagsFromResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RemoveTagsFromResourceMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - } - ], - "documentation":"Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
" - }, - "ResetDBParameterGroup":{ - "name":"ResetDBParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ResetDBParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"DBParameterGroupNameMessage", - "documentation":"
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", - "resultWrapper":"ResetDBParameterGroupResult" - }, - "errors":[ - { - "shape":"InvalidDBParameterGroupStateFault", - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB parameter group cannot be deleted because it is in use.
" - }, - { - "shape":"DBParameterGroupNotFoundFault", - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - } - ], - "documentation":" Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
" - }, - "output":{ - "shape":"RestoreDBInstanceFromDBSnapshotResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"DBSnapshotNotFoundFault", - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"InvalidDBSnapshotStateFault", - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"InvalidRestoreFault", - "error":{ - "code":"InvalidRestoreFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - { - "shape":"KMSKeyNotAccessibleFault", - "error":{ - "code":"KMSKeyNotAccessibleFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error accessing KMS key.
" - } - ], - "documentation":"Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
" - }, - "RestoreDBInstanceToPointInTime":{ - "name":"RestoreDBInstanceToPointInTime", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RestoreDBInstanceToPointInTimeMessage", - "documentation":"" - }, - "output":{ - "shape":"RestoreDBInstanceToPointInTimeResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", - "resultWrapper":"RestoreDBInstanceToPointInTimeResult" - }, - "errors":[ - { - "shape":"DBInstanceAlreadyExistsFault", - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - { - "shape":"DBInstanceNotFoundFault", - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - { - "shape":"InstanceQuotaExceededFault", - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - { - "shape":"InsufficientDBInstanceCapacityFault", - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - { - "shape":"InvalidDBInstanceStateFault", - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - { - "shape":"PointInTimeRestoreNotEnabledFault", - "error":{ - "code":"PointInTimeRestoreNotEnabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
" - }, - { - "shape":"StorageQuotaExceededFault", - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - { - "shape":"InvalidRestoreFault", - "error":{ - "code":"InvalidRestoreFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
" - }, - { - "shape":"DBSubnetGroupNotFoundFault", - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - { - "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - { - "shape":"ProvisionedIopsNotAvailableInAZFault", - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Provisioned IOPS not available in the specified Availability Zone.
" - }, - { - "shape":"OptionGroupNotFoundFault", - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - { - "shape":"StorageTypeNotSupportedFault", - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - { - "shape":"KMSKeyNotAccessibleFault", - "error":{ - "code":"KMSKeyNotAccessibleFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error accessing KMS key.
" - } - ], - "documentation":"Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
" - }, - "RevokeDBSecurityGroupIngress":{ - "name":"RevokeDBSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RevokeDBSecurityGroupIngressMessage", - "documentation":"" - }, - "output":{ - "shape":"RevokeDBSecurityGroupIngressResult", - "wrapper":true, - "documentation":"
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", - "resultWrapper":"RevokeDBSecurityGroupIngressResult" - }, - "errors":[ - { - "shape":"DBSecurityGroupNotFoundFault", - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - { - "shape":"InvalidDBSecurityGroupStateFault", - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - } - ], - "documentation":"Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" - } - }, - "shapes":{ - "AddSourceIdentifierToSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SourceIdentifier" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the RDS event notification subscription you want to add a source identifier to.
" - }, - "SourceIdentifier":{ - "shape":"String", - "documentation":"The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The tags to be assigned to the Amazon RDS resource.
" - } - }, - "documentation":"" - }, - "ApplyMethod":{ - "type":"string", - "enum":[ - "immediate", - "pending-reboot" - ] - }, - "ApplyPendingMaintenanceActionMessage":{ - "type":"structure", - "required":[ - "ResourceIdentifier", - "ApplyAction", - "OptInType" - ], - "members":{ - "ResourceIdentifier":{ - "shape":"String", - "documentation":"The ARN of the resource (for example, a DB Instance) that the pending maintenance action applies to.
" - }, - "ApplyAction":{ - "shape":"String", - "documentation":"The pending maintenance action to apply to this resource.
" - }, - "OptInType":{ - "shape":"String", - "documentation":"Specify an opt-in request, or undo an opt-in request. An opt-in request of type immediate cannot be undone.
Valid values:
immediate - Apply the maintenance action immediately.next-maintenance - Apply the maintenance action during the next maintenance window for the resource.undo-opt-in - Cancel any existing next-maintenance opt-in requests.The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
" - }, - "AuthorizationNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
" - }, - "AuthorizationQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB security group authorization quota has been reached.
" - }, - "AuthorizeDBSecurityGroupIngressMessage":{ - "type":"structure", - "required":["DBSecurityGroupName"], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the DB security group to add authorization to.
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":"The IP range to authorize.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":" Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
" - }, - "AvailabilityZone":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"
The name of the availability zone.
" - } - }, - "wrapper":true, - "documentation":"Contains Availability Zone information.
This data type is used as an element in the following data type:
" - }, - "AvailabilityZoneList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZone", - "locationName":"AvailabilityZone" - } - }, - "Boolean":{"type":"boolean"}, - "BooleanOptional":{"type":"boolean"}, - "CharacterSet":{ - "type":"structure", - "members":{ - "CharacterSetName":{ - "shape":"String", - "documentation":"The name of the character set.
" - }, - "CharacterSetDescription":{ - "shape":"String", - "documentation":"The description of the character set.
" - } - }, - "documentation":"This data type is used as a response element in the action DescribeDBEngineVersions.
" - }, - "CopyDBParameterGroupMessage":{ - "type":"structure", - "required":[ - "SourceDBParameterGroupIdentifier", - "TargetDBParameterGroupIdentifier", - "TargetDBParameterGroupDescription" - ], - "members":{ - "SourceDBParameterGroupIdentifier":{ - "shape":"String", - "documentation":"The identifier or ARN for the source DB parameter group.
Constraints:
my-db-param-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:pg:special-parameters.The identifier for the copied DB parameter group.
Constraints:
Example: my-db-parameter-group
A description for the copied DB parameter group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CopyDBSnapshotMessage":{ - "type":"structure", - "required":[ - "SourceDBSnapshotIdentifier", - "TargetDBSnapshotIdentifier" - ], - "members":{ - "SourceDBSnapshotIdentifier":{ - "shape":"String", - "documentation":"
The identifier for the source DB snapshot.
Constraints:
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copied snapshot.
Constraints:
Example: my-db-snapshot
" - }, - "CopyOptionGroupMessage":{ - "type":"structure", - "required":[ - "SourceOptionGroupIdentifier", - "TargetOptionGroupIdentifier", - "TargetOptionGroupDescription" - ], - "members":{ - "SourceOptionGroupIdentifier":{ - "shape":"String", - "documentation":"
The identifier or ARN for the source option group.
Constraints:
my-option-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:og:special-options.The identifier for the copied option group.
Constraints:
Example: my-option-group
The description for the copied option group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateDBInstanceMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "AllocatedStorage", - "DBInstanceClass", - "Engine", - "MasterUsername", - "MasterUserPassword" - ], - "members":{ - "DBName":{ - "shape":"String", - "documentation":"
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
" - }, - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 20 to 1024 (Express Edition and Web Edition)
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The compute and memory capacity of the DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The name of the database engine to be used for this instance.
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
Not every database engine is available for every AWS region.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"The name of master user for the client DB instance.
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
" - }, - "DBSecurityGroups":{ - "shape":"DBSecurityGroupNameList", - "documentation":"A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
" - }, - "VpcSecurityGroupIds":{ - "shape":"VpcSecurityGroupIdList", - "documentation":"A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which system maintenance can occur. For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
" - }, - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
MySQL
5.1.45 | 5.1.49 | 5.1.50 | 5.1.57 | 5.1.61 | 5.1.62 | 5.1.63 | 5.1.69 | 5.1.71 | 5.1.73 5.5.12 | 5.5.20 | 5.5.23 | 5.5.25a | 5.5.27 | 5.5.31 | 5.5.33 | 5.5.37 | 5.5.38 | 5.5.8 5.6.12 | 5.6.13 | 5.6.17 | 5.6.19 | 5.6.21 Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1 Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1 Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1 PostgreSQL
9.3.1 | 9.3.2 | 9.3.3 Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1 11.00.2100.60.v1 Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1 11.00.2100.60.v1 Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1 11.00.2100.60.v1 Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1 11.00.2100.60.v1 Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: To use PIOPS, this value must be an integer greater than 1000.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "CharacterSetName":{ - "shape":"String", - "documentation":"For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
" - }, - "PubliclyAccessible":{ - "shape":"BooleanOptional", - "documentation":"Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "Tags":{"shape":"TagList"}, - "StorageType":{ - "shape":"String", - "documentation":"Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - }, - "StorageEncrypted":{ - "shape":"BooleanOptional", - "documentation":"Specifies whether the DB instance is encrypted.
Default: false
" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
" - }, - "CreateDBInstanceReadReplicaMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "SourceDBInstanceIdentifier" - ], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
The DB instance identifier of the Read Replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
" - }, - "SourceDBInstanceIdentifier":{ - "shape":"String", - "documentation":"The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
Constraints:
The compute and memory capacity of the Read Replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: Inherits from the source DB instance.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Amazon EC2 Availability Zone that the Read Replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
" - }, - "PubliclyAccessible":{ - "shape":"BooleanOptional", - "documentation":"Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "Tags":{"shape":"TagList"}, - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
Specifies the storage type to be associated with the Read Replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The name of the DB parameter group.
Constraints:
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description for the DB parameter group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateDBSecurityGroupMessage":{ - "type":"structure", - "required":[ - "DBSecurityGroupName", - "DBSecurityGroupDescription" - ], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"
The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Example: mysecuritygroup
The description for the DB security group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateDBSnapshotMessage":{ - "type":"structure", - "required":[ - "DBSnapshotIdentifier", - "DBInstanceIdentifier" - ], - "members":{ - "DBSnapshotIdentifier":{ - "shape":"String", - "documentation":"
The identifier for the DB snapshot.
Constraints:
Example: my-snapshot-id
The DB instance identifier. This is the unique key that identifies a DB instance.
Constraints:
" - }, - "CreateDBSubnetGroupMessage":{ - "type":"structure", - "required":[ - "DBSubnetGroupName", - "DBSubnetGroupDescription", - "SubnetIds" - ], - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"The EC2 Subnet IDs for the DB subnet group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateEventSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SnsTopicArn" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the subscription.
Constraints: The name must be less than 255 characters.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" - }, - "SourceIds":{ - "shape":"SourceIdsList", - "documentation":"The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "CreateOptionGroupMessage":{ - "type":"structure", - "required":[ - "OptionGroupName", - "EngineName", - "MajorEngineVersion", - "OptionGroupDescription" - ], - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the option group to be created.
Constraints:
Example: myoptiongroup
Specifies the name of the engine that this option group should be associated with.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Specifies the major version of the engine that this option group should be associated with.
" - }, - "OptionGroupDescription":{ - "shape":"String", - "documentation":"The description of the option group.
" - }, - "Tags":{"shape":"TagList"} - }, - "documentation":"" - }, - "DBEngineVersion":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"The name of the database engine.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The version number of the database engine.
" - }, - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the DB parameter group family for the database engine.
" - }, - "DBEngineDescription":{ - "shape":"String", - "documentation":"The description of the database engine.
" - }, - "DBEngineVersionDescription":{ - "shape":"String", - "documentation":"The description of the database engine version.
" - }, - "DefaultCharacterSet":{ - "shape":"CharacterSet", - "documentation":" The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
This data type is used as a response element in the action DescribeDBEngineVersions.
" - }, - "DBEngineVersionList":{ - "type":"list", - "member":{ - "shape":"DBEngineVersion", - "locationName":"DBEngineVersion" - } - }, - "DBEngineVersionMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
" - }, - "DBInstance":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"Contains the name of the compute and memory capacity class of the DB instance.
" - }, - "Engine":{ - "shape":"String", - "documentation":"Provides the name of the database engine to be used for this DB instance.
" - }, - "DBInstanceStatus":{ - "shape":"String", - "documentation":"Specifies the current state of this database.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"Contains the master username for the DB instance.
" - }, - "DBName":{ - "shape":"String", - "documentation":"The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.
MySQL, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" - }, - "Endpoint":{ - "shape":"Endpoint", - "documentation":"Specifies the connection endpoint.
" - }, - "AllocatedStorage":{ - "shape":"Integer", - "documentation":"Specifies the allocated storage size specified in gigabytes.
" - }, - "InstanceCreateTime":{ - "shape":"TStamp", - "documentation":"Provides the date and time the DB instance was created.
" - }, - "PreferredBackupWindow":{ - "shape":"String", - "documentation":" Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the number of days for which automatic DB snapshots are retained.
" - }, - "DBSecurityGroups":{ - "shape":"DBSecurityGroupMembershipList", - "documentation":" Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
Provides List of VPC security group elements that the DB instance belongs to.
" - }, - "DBParameterGroups":{ - "shape":"DBParameterGroupStatusList", - "documentation":"Provides the list of DB parameter groups applied to this DB instance.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"Specifies the name of the Availability Zone the DB instance is located in.
" - }, - "DBSubnetGroup":{ - "shape":"DBSubnetGroup", - "documentation":"Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"Specifies the weekly time range (in UTC) during which system maintenance can occur.
" - }, - "PendingModifiedValues":{ - "shape":"PendingModifiedValues", - "documentation":"Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" - }, - "LatestRestorableTime":{ - "shape":"TStamp", - "documentation":"Specifies the latest time to which a database can be restored with point-in-time restore.
" - }, - "MultiAZ":{ - "shape":"Boolean", - "documentation":"Specifies if the DB instance is a Multi-AZ deployment.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"Indicates the database engine version.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"Indicates that minor version patches are applied automatically.
" - }, - "ReadReplicaSourceDBInstanceIdentifier":{ - "shape":"String", - "documentation":"Contains the identifier of the source DB instance if this DB instance is a Read Replica.
" - }, - "ReadReplicaDBInstanceIdentifiers":{ - "shape":"ReadReplicaDBInstanceIdentifierList", - "documentation":"Contains one or more identifiers of the Read Replicas associated with this DB instance.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for this DB instance.
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"Specifies the Provisioned IOPS (I/O operations per second) value.
" - }, - "OptionGroupMemberships":{ - "shape":"OptionGroupMembershipList", - "documentation":"Provides the list of option group memberships for this DB instance.
" - }, - "CharacterSetName":{ - "shape":"String", - "documentation":"If present, specifies the name of the character set that this instance is associated with.
" - }, - "SecondaryAvailabilityZone":{ - "shape":"String", - "documentation":"If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
" - }, - "PubliclyAccessible":{ - "shape":"Boolean", - "documentation":"Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "StatusInfos":{ - "shape":"DBInstanceStatusInfoList", - "documentation":"The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
" - }, - "StorageType":{ - "shape":"String", - "documentation":"Specifies the storage type associated with DB instance.
" - }, - "TdeCredentialArn":{ - "shape":"String", - "documentation":"The ARN from the Key Store with which the instance is associated for TDE encryption.
" - }, - "StorageEncrypted":{ - "shape":"Boolean", - "documentation":"Specifies whether the DB instance is encrypted.
" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":" If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
" - }, - "DBInstanceAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBInstanceAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a DB instance with the given identifier.
" - }, - "DBInstanceList":{ - "type":"list", - "member":{ - "shape":"DBInstance", - "locationName":"DBInstance" - } - }, - "DBInstanceMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
A list of DBInstance instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBInstances action.
" - }, - "DBInstanceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
" - }, - "DBInstanceStatusInfo":{ - "type":"structure", - "members":{ - "StatusType":{ - "shape":"String", - "documentation":"This value is currently \"read replication.\"
" - }, - "Normal":{ - "shape":"Boolean", - "documentation":"Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
" - }, - "Status":{ - "shape":"String", - "documentation":"Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
" - }, - "Message":{ - "shape":"String", - "documentation":"Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
" - } - }, - "documentation":"Provides a list of status information for a DB instance.
" - }, - "DBInstanceStatusInfoList":{ - "type":"list", - "member":{ - "shape":"DBInstanceStatusInfo", - "locationName":"DBInstanceStatusInfo" - } - }, - "DBParameterGroup":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"Provides the name of the DB parameter group.
" - }, - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"Provides the name of the DB parameter group family that this DB parameter group is compatible with.
" - }, - "Description":{ - "shape":"String", - "documentation":"Provides the customer-specified description for this DB parameter group.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
" - }, - "DBParameterGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB parameter group with the same name exists.
" - }, - "DBParameterGroupDetails":{ - "type":"structure", - "members":{ - "Parameters":{ - "shape":"ParametersList", - "documentation":"A list of Parameter values.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains the result of a successful invocation of the DescribeDBParameters action.
" - }, - "DBParameterGroupList":{ - "type":"list", - "member":{ - "shape":"DBParameterGroup", - "locationName":"DBParameterGroup" - } - }, - "DBParameterGroupNameMessage":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group.
" - } - }, - "documentation":"Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
" - }, - "DBParameterGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
" - }, - "DBParameterGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
" - }, - "DBParameterGroupStatus":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DP parameter group.
" - }, - "ParameterApplyStatus":{ - "shape":"String", - "documentation":"The status of parameter updates.
" - } - }, - "documentation":"The status of the DB parameter group.
This data type is used as a response element in the following actions:
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBParameterGroup instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBParameterGroups action.
" - }, - "DBSecurityGroup":{ - "type":"structure", - "members":{ - "OwnerId":{ - "shape":"String", - "documentation":"Provides the AWS ID of the owner of a specific DB security group.
" - }, - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the DB security group.
" - }, - "DBSecurityGroupDescription":{ - "shape":"String", - "documentation":"Provides the description of the DB security group.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"Provides the VpcId of the DB security group.
" - }, - "EC2SecurityGroups":{ - "shape":"EC2SecurityGroupList", - "documentation":"Contains a list of EC2SecurityGroup elements.
" - }, - "IPRanges":{ - "shape":"IPRangeList", - "documentation":"Contains a list of IPRange elements.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
" - }, - "DBSecurityGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSecurityGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group with the name specified in DBSecurityGroupName already exists.
" - }, - "DBSecurityGroupMembership":{ - "type":"structure", - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the DB security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the DB security group.
" - } - }, - "documentation":"This data type is used as a response element in the following actions:
" - }, - "DBSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"DBSecurityGroupMembership", - "locationName":"DBSecurityGroup" - } - }, - "DBSecurityGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBSecurityGroup instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
" - }, - "DBSecurityGroupNameList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"DBSecurityGroupName" - } - }, - "DBSecurityGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
" - }, - "DBSecurityGroupNotSupportedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSecurityGroupNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A DB security group is not allowed for this action.
" - }, - "DBSecurityGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"QuotaExceeded.DBSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB security groups.
" - }, - "DBSecurityGroups":{ - "type":"list", - "member":{ - "shape":"DBSecurityGroup", - "locationName":"DBSecurityGroup" - } - }, - "DBSnapshot":{ - "type":"structure", - "members":{ - "DBSnapshotIdentifier":{ - "shape":"String", - "documentation":"Specifies the identifier for the DB snapshot.
" - }, - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
" - }, - "SnapshotCreateTime":{ - "shape":"TStamp", - "documentation":"Provides the time (UTC) when the snapshot was taken.
" - }, - "Engine":{ - "shape":"String", - "documentation":"Specifies the name of the database engine.
" - }, - "AllocatedStorage":{ - "shape":"Integer", - "documentation":"Specifies the allocated storage size in gigabytes (GB).
" - }, - "Status":{ - "shape":"String", - "documentation":"Specifies the status of this DB snapshot.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"Specifies the port that the database engine was listening on at the time of the snapshot.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"Provides the Vpc Id associated with the DB snapshot.
" - }, - "InstanceCreateTime":{ - "shape":"TStamp", - "documentation":"Specifies the time (UTC) when the snapshot was taken.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"Provides the master username for the DB snapshot.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"Specifies the version of the database engine.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for the restored DB instance.
" - }, - "SnapshotType":{ - "shape":"String", - "documentation":"Provides the type of the DB snapshot.
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"Provides the option group name for the DB snapshot.
" - }, - "PercentProgress":{ - "shape":"Integer", - "documentation":"The percentage of the estimated data that has been transferred.
" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The region that the DB snapshot was created in or copied from.
" - }, - "StorageType":{ - "shape":"String", - "documentation":"Specifies the storage type associated with DB Snapshot.
" - }, - "TdeCredentialArn":{ - "shape":"String", - "documentation":"The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Specifies whether the DB snapshot is encrypted.
" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":" If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
" - }, - "DBSnapshotAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
" - }, - "DBSnapshotList":{ - "type":"list", - "member":{ - "shape":"DBSnapshot", - "locationName":"DBSnapshot" - } - }, - "DBSnapshotMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBSnapshot instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBSnapshots action.
" - }, - "DBSnapshotNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
" - }, - "DBSubnetGroup":{ - "type":"structure", - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the DB subnet group.
" - }, - "DBSubnetGroupDescription":{ - "shape":"String", - "documentation":"Provides the description of the DB subnet group.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"Provides the VpcId of the DB subnet group.
" - }, - "SubnetGroupStatus":{ - "shape":"String", - "documentation":"Provides the status of the DB subnet group.
" - }, - "Subnets":{ - "shape":"SubnetList", - "documentation":"Contains a list of Subnet elements.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
" - }, - "DBSubnetGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName is already used by an existing DB subnet group.
" - }, - "DBSubnetGroupDoesNotCoverEnoughAZs":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupDoesNotCoverEnoughAZs", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
" - }, - "DBSubnetGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of DBSubnetGroup instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
" - }, - "DBSubnetGroupNotAllowedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupNotAllowedFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
" - }, - "DBSubnetGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
" - }, - "DBSubnetGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB subnet groups.
" - }, - "DBSubnetGroups":{ - "type":"list", - "member":{ - "shape":"DBSubnetGroup", - "locationName":"DBSubnetGroup" - } - }, - "DBSubnetQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
" - }, - "DBUpgradeDependencyFailureFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"DBUpgradeDependencyFailure", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB upgrade failed because a resource the DB depends on could not be modified.
" - }, - "DeleteDBInstanceMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
Constraints:
Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
Specify true when deleting a Read Replica.
false.Default: false
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Constraints:
" - }, - "DeleteDBParameterGroupMessage":{ - "type":"structure", - "required":["DBParameterGroupName"], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"
The name of the DB parameter group.
Constraints:
" - }, - "DeleteDBSecurityGroupMessage":{ - "type":"structure", - "required":["DBSecurityGroupName"], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"
The name of the DB security group to delete.
Constraints:
" - }, - "DeleteDBSnapshotMessage":{ - "type":"structure", - "required":["DBSnapshotIdentifier"], - "members":{ - "DBSnapshotIdentifier":{ - "shape":"String", - "documentation":"
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
" - }, - "DeleteDBSubnetGroupMessage":{ - "type":"structure", - "required":["DBSubnetGroupName"], - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the database subnet group to delete.
Constraints:
" - }, - "DeleteEventSubscriptionMessage":{ - "type":"structure", - "required":["SubscriptionName"], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the RDS event notification subscription you want to delete.
" - } - }, - "documentation":"" - }, - "DeleteOptionGroupMessage":{ - "type":"structure", - "required":["OptionGroupName"], - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be deleted.
" - }, - "DescribeDBEngineVersionsMessage":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"
The database engine to return.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
Not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Indicates that only the default version of the specified engine or engine and major version combination is returned.
" - }, - "ListSupportedCharacterSets":{ - "shape":"BooleanOptional", - "documentation":"If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
" - } - } - }, - "DescribeDBInstancesMessage":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.
Constraints:
This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
" - }, - "DescribeDBLogFilesDetails":{ - "type":"structure", - "members":{ - "LogFileName":{ - "shape":"String", - "documentation":"
The name of the log file for the specified DB instance.
" - }, - "LastWritten":{ - "shape":"Long", - "documentation":"A POSIX timestamp when the last log entry was written.
" - }, - "Size":{ - "shape":"Long", - "documentation":"The size, in bytes, of the log file for the specified DB instance.
" - } - }, - "documentation":"This data type is used as a response element to DescribeDBLogFiles.
" - }, - "DescribeDBLogFilesList":{ - "type":"list", - "member":{ - "shape":"DescribeDBLogFilesDetails", - "locationName":"DescribeDBLogFilesDetails" - } - }, - "DescribeDBLogFilesMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Filters the available log files for log file names that contain the specified string.
" - }, - "FileLastWritten":{ - "shape":"Long", - "documentation":"Filters the available log files for files written since the specified date, in POSIX timestamp format.
" - }, - "FileSize":{ - "shape":"Long", - "documentation":"Filters the available log files for files larger than the specified size.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
" - }, - "Marker":{ - "shape":"String", - "documentation":"The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
" - } - }, - "documentation":"" - }, - "DescribeDBLogFilesResponse":{ - "type":"structure", - "members":{ - "DescribeDBLogFiles":{ - "shape":"DescribeDBLogFilesList", - "documentation":"
The DB log files returned.
" - }, - "Marker":{ - "shape":"String", - "documentation":"A pagination token that can be used in a subsequent DescribeDBLogFiles request.
" - } - }, - "documentation":"The response from a call to DescribeDBLogFiles.
" - }, - "DescribeDBParameterGroupsMessage":{ - "type":"structure", - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of a specific DB parameter group to return details for.
Constraints:
This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeDBParametersMessage":{ - "type":"structure", - "required":["DBParameterGroupName"], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"
The name of a specific DB parameter group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeDBSnapshotsMessage":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.
Constraints:
A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeDBSubnetGroupsMessage":{ - "type":"structure", - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the DB subnet group to return details for.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeEngineDefaultParametersMessage":{ - "type":"structure", - "required":["DBParameterGroupFamily"], - "members":{ - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"
The name of the DB parameter group family.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"Not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeEventCategoriesMessage":{ - "type":"structure", - "members":{ - "SourceType":{ - "shape":"String", - "documentation":"
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - } - }, - "documentation":"" - }, - "DescribeEventSubscriptionsMessage":{ - "type":"structure", - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the RDS event notification subscription you want to describe.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
Constraints:
DBInstance, then a DBInstanceIdentifier must be supplied.DBSecurityGroup, a DBSecurityGroupName must be supplied.DBParameterGroup, a DBParameterGroupName must be supplied.DBSnapshot, a DBSnapshotIdentifier must be supplied.The event source to retrieve events for. If no value is specified, all events are returned.
" - }, - "StartTime":{ - "shape":"TStamp", - "documentation":"The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
" - }, - "EndTime":{ - "shape":"TStamp", - "documentation":"The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
" - }, - "Duration":{ - "shape":"IntegerOptional", - "documentation":"The number of minutes to retrieve events for.
Default: 60
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories that trigger notifications for a event notification subscription.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeOptionGroupOptionsMessage":{ - "type":"structure", - "required":["EngineName"], - "members":{ - "EngineName":{ - "shape":"String", - "documentation":"
A required parameter. Options available for the given Engine name will be described.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"If specified, filters the results to include only options for the specified major engine version.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeOptionGroupsMessage":{ - "type":"structure", - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "EngineName":{ - "shape":"String", - "documentation":"Filters the list of option groups to only include groups associated with a specific database engine.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
" - } - }, - "documentation":"" - }, - "DescribeOrderableDBInstanceOptionsMessage":{ - "type":"structure", - "required":["Engine"], - "members":{ - "Engine":{ - "shape":"String", - "documentation":"
The name of the engine to retrieve DB instance options for.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
" - }, - "Vpc":{ - "shape":"BooleanOptional", - "documentation":"The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
" - }, - "DescribePendingMaintenanceActionsMessage":{ - "type":"structure", - "members":{ - "ResourceIdentifier":{ - "shape":"String", - "documentation":"
The ARN of the resource to return pending maintenance actions for.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The result list will only include maintenance actions for the specified DB Instances. An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords .
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - } - }, - "documentation":"" - }, - "DescribeReservedDBInstancesMessage":{ - "type":"structure", - "members":{ - "ReservedDBInstanceId":{ - "shape":"String", - "documentation":"The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
" - }, - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
" - }, - "Duration":{ - "shape":"String", - "documentation":"The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "DescribeReservedDBInstancesOfferingsMessage":{ - "type":"structure", - "members":{ - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
" - }, - "Duration":{ - "shape":"String", - "documentation":"Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "Double":{"type":"double"}, - "DownloadDBLogFilePortionDetails":{ - "type":"structure", - "members":{ - "LogFileData":{ - "shape":"String", - "documentation":"
Entries from the specified log file.
" - }, - "Marker":{ - "shape":"String", - "documentation":"A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
" - }, - "AdditionalDataPending":{ - "shape":"Boolean", - "documentation":"Boolean value that if true, indicates there is more data to be downloaded.
" - } - }, - "documentation":"This data type is used as a response element to DownloadDBLogFilePortion.
" - }, - "DownloadDBLogFilePortionMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "LogFileName" - ], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
The name of the log file to be downloaded.
" - }, - "Marker":{ - "shape":"String", - "documentation":"The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
" - }, - "NumberOfLines":{ - "shape":"Integer", - "documentation":"The number of lines to download.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
" - }, - "EC2SecurityGroup":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"
Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the EC2 security group.
" - }, - "EC2SecurityGroupId":{ - "shape":"String", - "documentation":"Specifies the id of the EC2 security group.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":" Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
This data type is used as a response element in the following actions:
" - }, - "EC2SecurityGroupList":{ - "type":"list", - "member":{ - "shape":"EC2SecurityGroup", - "locationName":"EC2SecurityGroup" - } - }, - "Endpoint":{ - "type":"structure", - "members":{ - "Address":{ - "shape":"String", - "documentation":"Specifies the DNS address of the DB instance.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"Specifies the port that the database engine is listening on.
" - } - }, - "documentation":"This data type is used as a response element in the following actions:
" - }, - "EngineDefaults":{ - "type":"structure", - "members":{ - "DBParameterGroupFamily":{ - "shape":"String", - "documentation":"Specifies the name of the DB parameter group family which the engine default parameters apply to.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Contains a list of engine default parameters.
" - } - }, - "wrapper":true, - "documentation":"Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
" - }, - "Event":{ - "type":"structure", - "members":{ - "SourceIdentifier":{ - "shape":"String", - "documentation":"Provides the identifier for the source of the event.
" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"Specifies the source type for this event.
" - }, - "Message":{ - "shape":"String", - "documentation":"Provides the text of this event.
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"Specifies the category for the event.
" - }, - "Date":{ - "shape":"TStamp", - "documentation":"Specifies the date and time of the event.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeEvents action.
" - }, - "EventCategoriesList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"EventCategory" - } - }, - "EventCategoriesMap":{ - "type":"structure", - "members":{ - "SourceType":{ - "shape":"String", - "documentation":"The source type that the returned categories belong to
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"The event categories for the specified source type
" - } - }, - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventCategories action.
" - }, - "EventCategoriesMapList":{ - "type":"list", - "member":{ - "shape":"EventCategoriesMap", - "locationName":"EventCategoriesMap" - } - }, - "EventCategoriesMessage":{ - "type":"structure", - "members":{ - "EventCategoriesMapList":{ - "shape":"EventCategoriesMapList", - "documentation":"A list of EventCategoriesMap data types.
" - } - }, - "documentation":"Data returned from the DescribeEventCategories action.
" - }, - "EventList":{ - "type":"list", - "member":{ - "shape":"Event", - "locationName":"Event" - } - }, - "EventSubscription":{ - "type":"structure", - "members":{ - "CustomerAwsId":{ - "shape":"String", - "documentation":"The AWS customer account associated with the RDS event notification subscription.
" - }, - "CustSubscriptionId":{ - "shape":"String", - "documentation":"The RDS event notification subscription Id.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The topic ARN of the RDS event notification subscription.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
" - }, - "SubscriptionCreationTime":{ - "shape":"String", - "documentation":"The time the RDS event notification subscription was created.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The source type for the RDS event notification subscription.
" - }, - "SourceIdsList":{ - "shape":"SourceIdsList", - "documentation":"A list of source IDs for the RDS event notification subscription.
" - }, - "EventCategoriesList":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories for the RDS event notification subscription.
" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
" - } - }, - "wrapper":true, - "documentation":"Contains the results of a successful invocation of the DescribeEventSubscriptions action.
" - }, - "EventSubscriptionQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You have reached the maximum number of event subscriptions.
" - }, - "EventSubscriptionsList":{ - "type":"list", - "member":{ - "shape":"EventSubscription", - "locationName":"EventSubscription" - } - }, - "EventSubscriptionsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of EventSubscriptions data types.
" - } - }, - "documentation":"Data returned by the DescribeEventSubscriptions action.
" - }, - "EventsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
A list of Event instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeEvents action.
" - }, - "Filter":{ - "type":"structure", - "required":[ - "Name", - "Values" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"This parameter is not currently supported.
" - }, - "Values":{ - "shape":"FilterValueList", - "documentation":"This parameter is not currently supported.
" - } - } - }, - "FilterList":{ - "type":"list", - "member":{ - "shape":"Filter", - "locationName":"Filter" - } - }, - "FilterValueList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"Value" - } - }, - "IPRange":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":"Specifies the IP range.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeDBSecurityGroups action.
" - }, - "IPRangeList":{ - "type":"list", - "member":{ - "shape":"IPRange", - "locationName":"IPRange" - } - }, - "InstanceQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB instances.
" - }, - "InsufficientDBInstanceCapacityFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientDBInstanceCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Specified DB instance class is not available in the specified Availability Zone.
" - }, - "Integer":{"type":"integer"}, - "IntegerOptional":{"type":"integer"}, - "InvalidDBInstanceStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBInstanceState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified DB instance is not in the available state.
" - }, - "InvalidDBParameterGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB parameter group cannot be deleted because it is in use.
" - }, - "InvalidDBSecurityGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB security group does not allow deletion.
" - }, - "InvalidDBSnapshotStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the DB snapshot does not allow deletion.
" - }, - "InvalidDBSubnetGroupFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSubnetGroupFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
" - }, - "InvalidDBSubnetGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet group cannot be deleted because it is in use.
" - }, - "InvalidDBSubnetStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidDBSubnetStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is not in the available state.
" - }, - "InvalidEventSubscriptionStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidEventSubscriptionState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This error can occur if someone else is modifying a subscription. You should retry the action.
" - }, - "InvalidOptionGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidOptionGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The option group is not in the available state.
" - }, - "InvalidRestoreFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidRestoreFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
" - }, - "InvalidSubnet":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
" - }, - "InvalidVPCNetworkStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
" - }, - "KMSKeyNotAccessibleFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"KMSKeyNotAccessibleFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error accessing KMS key.
" - }, - "KeyList":{ - "type":"list", - "member":{"shape":"String"} - }, - "ListTagsForResourceMessage":{ - "type":"structure", - "required":["ResourceName"], - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":"The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" - }, - "Filters":{ - "shape":"FilterList", - "documentation":"This parameter is not currently supported.
" - } - }, - "documentation":"" - }, - "Long":{"type":"long"}, - "ModifyDBInstanceMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier. This value is stored as a lowercase string.
Constraints:
The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.
If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.
Default: false
The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
" - }, - "BackupRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":" Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":" The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
" - }, - "AllowMajorVersionUpgrade":{ - "shape":"Boolean", - "documentation":"Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":" Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":" Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "NewDBInstanceIdentifier":{ - "shape":"String", - "documentation":" The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "ModifyDBParameterGroupMessage":{ - "type":"structure", - "required":[ - "DBParameterGroupName", - "Parameters" - ], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"
The name of the DB parameter group.
Constraints:
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
" - }, - "ModifyDBSubnetGroupMessage":{ - "type":"structure", - "required":[ - "DBSubnetGroupName", - "SubnetIds" - ], - "members":{ - "DBSubnetGroupName":{ - "shape":"String", - "documentation":"
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"The EC2 subnet IDs for the DB subnet group.
" - } - }, - "documentation":"" - }, - "ModifyEventSubscriptionMessage":{ - "type":"structure", - "required":["SubscriptionName"], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the RDS event notification subscription.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" - }, - "Enabled":{ - "shape":"BooleanOptional", - "documentation":"A Boolean value; set to true to activate the subscription.
" - } - }, - "documentation":"" - }, - "ModifyOptionGroupMessage":{ - "type":"structure", - "required":["OptionGroupName"], - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "OptionsToInclude":{ - "shape":"OptionConfigurationList", - "documentation":"Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
" - }, - "OptionsToRemove":{ - "shape":"OptionNamesList", - "documentation":"Options in this list are removed from the option group.
" - }, - "ApplyImmediately":{ - "shape":"Boolean", - "documentation":"Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
" - } - }, - "documentation":"" - }, - "Option":{ - "type":"structure", - "members":{ - "OptionName":{ - "shape":"String", - "documentation":"
The name of the option.
" - }, - "OptionDescription":{ - "shape":"String", - "documentation":"The description of the option.
" - }, - "Persistent":{ - "shape":"Boolean", - "documentation":"Indicate if this option is persistent.
" - }, - "Permanent":{ - "shape":"Boolean", - "documentation":"Indicate if this option is permanent.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"If required, the port configured for this option to use.
" - }, - "OptionSettings":{ - "shape":"OptionSettingConfigurationList", - "documentation":"The option settings for this option.
" - }, - "DBSecurityGroupMemberships":{ - "shape":"DBSecurityGroupMembershipList", - "documentation":"If the option requires access to a port, then this DB security group allows access to the port.
" - }, - "VpcSecurityGroupMemberships":{ - "shape":"VpcSecurityGroupMembershipList", - "documentation":"If the option requires access to a port, then this VPC security group allows access to the port.
" - } - }, - "documentation":"Option details.
" - }, - "OptionConfiguration":{ - "type":"structure", - "required":["OptionName"], - "members":{ - "OptionName":{ - "shape":"String", - "documentation":"The configuration of options to include in a group.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The optional port for the option.
" - }, - "DBSecurityGroupMemberships":{ - "shape":"DBSecurityGroupNameList", - "documentation":"A list of DBSecurityGroupMemebrship name strings used for this option.
" - }, - "VpcSecurityGroupMemberships":{ - "shape":"VpcSecurityGroupIdList", - "documentation":"A list of VpcSecurityGroupMemebrship name strings used for this option.
" - }, - "OptionSettings":{ - "shape":"OptionSettingsList", - "documentation":"The option settings to include in an option group.
" - } - }, - "documentation":"A list of all available options
" - }, - "OptionConfigurationList":{ - "type":"list", - "member":{ - "shape":"OptionConfiguration", - "locationName":"OptionConfiguration" - } - }, - "OptionGroup":{ - "type":"structure", - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"Specifies the name of the option group.
" - }, - "OptionGroupDescription":{ - "shape":"String", - "documentation":"Provides a description of the option group.
" - }, - "EngineName":{ - "shape":"String", - "documentation":"Engine name that this option group can be applied to.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Indicates the major engine version associated with this option group.
" - }, - "Options":{ - "shape":"OptionsList", - "documentation":"Indicates what options are available in the option group.
" - }, - "AllowsVpcAndNonVpcInstanceMemberships":{ - "shape":"Boolean", - "documentation":"Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
" - }, - "OptionGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OptionGroupAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The option group you are trying to create already exists.
" - }, - "OptionGroupMembership":{ - "type":"structure", - "members":{ - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group that the instance belongs to.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).
" - } - }, - "documentation":"Provides information on the option groups the DB instance is a member of.
" - }, - "OptionGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"OptionGroupMembership", - "locationName":"OptionGroupMembership" - } - }, - "OptionGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OptionGroupNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified option group could not be found.
" - }, - "OptionGroupOption":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the option.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the option.
" - }, - "EngineName":{ - "shape":"String", - "documentation":"The name of the engine that this option can be applied to.
" - }, - "MajorEngineVersion":{ - "shape":"String", - "documentation":"Indicates the major engine version that the option is available for.
" - }, - "MinimumRequiredMinorEngineVersion":{ - "shape":"String", - "documentation":"The minimum required engine version for the option to be applied.
" - }, - "PortRequired":{ - "shape":"Boolean", - "documentation":"Specifies whether the option requires a port.
" - }, - "DefaultPort":{ - "shape":"IntegerOptional", - "documentation":"If the option requires a port, specifies the default port for the option.
" - }, - "OptionsDependedOn":{ - "shape":"OptionsDependedOn", - "documentation":"List of all options that are prerequisites for this option.
" - }, - "Persistent":{ - "shape":"Boolean", - "documentation":"A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.
" - }, - "Permanent":{ - "shape":"Boolean", - "documentation":"A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.
" - }, - "OptionGroupOptionSettings":{ - "shape":"OptionGroupOptionSettingsList", - "documentation":"Specifies the option settings that are available (and the default value) for each option in an option group.
" - } - }, - "documentation":"Available option.
" - }, - "OptionGroupOptionSetting":{ - "type":"structure", - "members":{ - "SettingName":{ - "shape":"String", - "documentation":"The name of the option group option.
" - }, - "SettingDescription":{ - "shape":"String", - "documentation":"The description of the option group option.
" - }, - "DefaultValue":{ - "shape":"String", - "documentation":"The default value for the option group option.
" - }, - "ApplyType":{ - "shape":"String", - "documentation":"The DB engine specific parameter type for the option group option.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"Indicates the acceptable values for the option group option.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":"Boolean value where true indicates that this option group option can be changed from the default value.
" - } - }, - "documentation":"Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
" - }, - "OptionGroupOptionSettingsList":{ - "type":"list", - "member":{ - "shape":"OptionGroupOptionSetting", - "locationName":"OptionGroupOptionSetting" - } - }, - "OptionGroupOptionsList":{ - "type":"list", - "member":{ - "shape":"OptionGroupOption", - "locationName":"OptionGroupOption" - }, - "documentation":"List of available option group options.
" - }, - "OptionGroupOptionsMessage":{ - "type":"structure", - "members":{ - "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, - "Marker":{ - "shape":"String", - "documentation":"An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
" - }, - "OptionGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OptionGroupQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The quota of 20 option groups was exceeded for this AWS account.
" - }, - "OptionGroups":{ - "type":"structure", - "members":{ - "OptionGroupsList":{ - "shape":"OptionGroupsList", - "documentation":"List of option groups.
" - }, - "Marker":{ - "shape":"String", - "documentation":"An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
List of option groups.
" - }, - "OptionGroupsList":{ - "type":"list", - "member":{ - "shape":"OptionGroup", - "locationName":"OptionGroup" - } - }, - "OptionNamesList":{ - "type":"list", - "member":{"shape":"String"} - }, - "OptionSetting":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the option that has settings that you can set.
" - }, - "Value":{ - "shape":"String", - "documentation":"The current value of the option setting.
" - }, - "DefaultValue":{ - "shape":"String", - "documentation":"The default value of the option setting.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the option setting.
" - }, - "ApplyType":{ - "shape":"String", - "documentation":"The DB engine specific parameter type.
" - }, - "DataType":{ - "shape":"String", - "documentation":"The data type of the option setting.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"The allowed values of the option setting.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":"A Boolean value that, when true, indicates the option setting can be modified from the default.
" - }, - "IsCollection":{ - "shape":"Boolean", - "documentation":"Indicates if the option setting is part of a collection.
" - } - }, - "documentation":"Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
" - }, - "OptionSettingConfigurationList":{ - "type":"list", - "member":{ - "shape":"OptionSetting", - "locationName":"OptionSetting" - } - }, - "OptionSettingsList":{ - "type":"list", - "member":{ - "shape":"OptionSetting", - "locationName":"OptionSetting" - } - }, - "OptionsDependedOn":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"OptionName" - } - }, - "OptionsList":{ - "type":"list", - "member":{ - "shape":"Option", - "locationName":"Option" - } - }, - "OrderableDBInstanceOption":{ - "type":"structure", - "members":{ - "Engine":{ - "shape":"String", - "documentation":"The engine type of the orderable DB instance.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"The engine version of the orderable DB instance.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance Class for the orderable DB instance
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"The license model for the orderable DB instance.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZoneList", - "documentation":"A list of availability zones for the orderable DB instance.
" - }, - "MultiAZCapable":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance is multi-AZ capable.
" - }, - "ReadReplicaCapable":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance can have a Read Replica.
" - }, - "Vpc":{ - "shape":"Boolean", - "documentation":"Indicates whether this is a VPC orderable DB instance.
" - }, - "SupportsStorageEncryption":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance supports encrypted storage.
" - }, - "StorageType":{ - "shape":"String", - "documentation":"The storage type for this orderable DB instance.
" - }, - "SupportsIops":{ - "shape":"Boolean", - "documentation":"Indicates whether this orderable DB instance supports provisioned IOPS.
" - } - }, - "wrapper":true, - "documentation":"Contains a list of available options for a DB instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
" - }, - "OrderableDBInstanceOptionsList":{ - "type":"list", - "member":{ - "shape":"OrderableDBInstanceOption", - "locationName":"OrderableDBInstanceOption" - } - }, - "OrderableDBInstanceOptionsMessage":{ - "type":"structure", - "members":{ - "OrderableDBInstanceOptions":{ - "shape":"OrderableDBInstanceOptionsList", - "documentation":"An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
" - }, - "Parameter":{ - "type":"structure", - "members":{ - "ParameterName":{ - "shape":"String", - "documentation":"Specifies the name of the parameter.
" - }, - "ParameterValue":{ - "shape":"String", - "documentation":"Specifies the value of the parameter.
" - }, - "Description":{ - "shape":"String", - "documentation":"Provides a description of the parameter.
" - }, - "Source":{ - "shape":"String", - "documentation":"Indicates the source of the parameter value.
" - }, - "ApplyType":{ - "shape":"String", - "documentation":"Specifies the engine specific parameters type.
" - }, - "DataType":{ - "shape":"String", - "documentation":"Specifies the valid data type for the parameter.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"Specifies the valid range of values for the parameter.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":" Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
" - }, - "ApplyMethod":{ - "shape":"ApplyMethod", - "documentation":"Indicates when to apply parameter updates.
" - } - }, - "documentation":"This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
" - }, - "ParametersList":{ - "type":"list", - "member":{ - "shape":"Parameter", - "locationName":"Parameter" - } - }, - "PendingMaintenanceAction":{ - "type":"structure", - "members":{ - "Action":{ - "shape":"String", - "documentation":"The type of pending maintenance action that is available for the resource.
" - }, - "AutoAppliedAfterDate":{ - "shape":"TStamp", - "documentation":"The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.
The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
Indicates the type of opt-in request that has been received for the resource.
" - }, - "CurrentApplyDate":{ - "shape":"TStamp", - "documentation":"The effective date when the pending maintenance action will be applied to the resource. This takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and no value has been specified for the AutoAppliedAfterDate or ForcedApplyDate.
Provides information about a pending maintenance action for a resource.
" - }, - "PendingMaintenanceActionDetails":{ - "type":"list", - "member":{ - "shape":"PendingMaintenanceAction", - "locationName":"PendingMaintenanceAction" - } - }, - "PendingMaintenanceActions":{ - "type":"list", - "member":{ - "shape":"ResourcePendingMaintenanceActions", - "locationName":"ResourcePendingMaintenanceActions" - } - }, - "PendingMaintenanceActionsMessage":{ - "type":"structure", - "members":{ - "PendingMaintenanceActions":{ - "shape":"PendingMaintenanceActions", - "documentation":"Provides a list of the pending maintenance actions for the resource.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords .
Data returned from the DescribePendingMaintenanceActions action.
" - }, - "PendingModifiedValues":{ - "type":"structure", - "members":{ - "DBInstanceClass":{ - "shape":"String", - "documentation":" Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB instance.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"Specifies the pending port for the DB instance.
" - }, - "BackupRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"Specifies the pending number of days for which automated backups are retained.
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":"Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
" - }, - "EngineVersion":{ - "shape":"String", - "documentation":"Indicates the database engine version.
" - }, - "Iops":{ - "shape":"IntegerOptional", - "documentation":"Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
" - }, - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":" Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
Specifies the storage type to be associated with the DB instance.
" - } - }, - "documentation":"This data type is used as a response element in the ModifyDBInstance action.
" - }, - "PointInTimeRestoreNotEnabledFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"PointInTimeRestoreNotEnabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
" - }, - "PromoteReadReplicaMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Example:
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
" - }, - "ProvisionedIopsNotAvailableInAZFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ProvisionedIopsNotAvailableInAZFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
Provisioned IOPS not available in the specified Availability Zone.
" - }, - "PurchaseReservedDBInstancesOfferingMessage":{ - "type":"structure", - "required":["ReservedDBInstancesOfferingId"], - "members":{ - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
" - }, - "ReservedDBInstanceId":{ - "shape":"String", - "documentation":"Customer-specified identifier to track this reservation.
Example: myreservationID
" - }, - "DBInstanceCount":{ - "shape":"IntegerOptional", - "documentation":"The number of instances to reserve.
Default: 1
" - }, - "ReadReplicaDBInstanceIdentifierList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ReadReplicaDBInstanceIdentifier" - } - }, - "RebootDBInstanceMessage":{ - "type":"structure", - "required":["DBInstanceIdentifier"], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
" - }, - "RecurringCharge":{ - "type":"structure", - "members":{ - "RecurringChargeAmount":{ - "shape":"Double", - "documentation":"
The amount of the recurring charge.
" - }, - "RecurringChargeFrequency":{ - "shape":"String", - "documentation":"The frequency of the recurring charge.
" - } - }, - "wrapper":true, - "documentation":"This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
" - }, - "RecurringChargeList":{ - "type":"list", - "member":{ - "shape":"RecurringCharge", - "locationName":"RecurringCharge" - } - }, - "RemoveSourceIdentifierFromSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SourceIdentifier" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the RDS event notification subscription you want to remove a source identifier from.
" - }, - "SourceIdentifier":{ - "shape":"String", - "documentation":"The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
" - } - }, - "documentation":"" - }, - "RemoveTagsFromResourceMessage":{ - "type":"structure", - "required":[ - "ResourceName", - "TagKeys" - ], - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":"The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
" - }, - "TagKeys":{ - "shape":"KeyList", - "documentation":"The tag key (name) of the tag to be removed.
" - } - }, - "documentation":"" - }, - "ReservedDBInstance":{ - "type":"structure", - "members":{ - "ReservedDBInstanceId":{ - "shape":"String", - "documentation":"The unique identifier for the reservation.
" - }, - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class for the reserved DB instance.
" - }, - "StartTime":{ - "shape":"TStamp", - "documentation":"The time the reservation started.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the reservation in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed price charged for this reserved DB instance.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly price charged for this reserved DB instance.
" - }, - "CurrencyCode":{ - "shape":"String", - "documentation":"The currency code for the reserved DB instance.
" - }, - "DBInstanceCount":{ - "shape":"Integer", - "documentation":"The number of reserved DB instances.
" - }, - "ProductDescription":{ - "shape":"String", - "documentation":"The description of the reserved DB instance.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type of this reserved DB instance.
" - }, - "MultiAZ":{ - "shape":"Boolean", - "documentation":"Indicates if the reservation applies to Multi-AZ deployments.
" - }, - "State":{ - "shape":"String", - "documentation":"The state of the reserved DB instance.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring price charged to run this reserved DB instance.
" - } - }, - "wrapper":true, - "documentation":"This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
" - }, - "ReservedDBInstanceAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstanceAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a reservation with the given identifier.
" - }, - "ReservedDBInstanceList":{ - "type":"list", - "member":{ - "shape":"ReservedDBInstance", - "locationName":"ReservedDBInstance" - } - }, - "ReservedDBInstanceMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of reserved DB instances.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeReservedDBInstances action.
" - }, - "ReservedDBInstanceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstanceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified reserved DB Instance not found.
" - }, - "ReservedDBInstanceQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstanceQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would exceed the user's DB Instance quota.
" - }, - "ReservedDBInstancesOffering":{ - "type":"structure", - "members":{ - "ReservedDBInstancesOfferingId":{ - "shape":"String", - "documentation":"The offering identifier.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The DB instance class for the reserved DB instance.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the offering in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed price charged for this offering.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly price charged for this offering.
" - }, - "CurrencyCode":{ - "shape":"String", - "documentation":"The currency code for the reserved DB instance offering.
" - }, - "ProductDescription":{ - "shape":"String", - "documentation":"The database engine used by the offering.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The offering type.
" - }, - "MultiAZ":{ - "shape":"Boolean", - "documentation":"Indicates if the offering applies to Multi-AZ deployments.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring price charged to run this reserved DB instance.
" - } - }, - "wrapper":true, - "documentation":"This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
" - }, - "ReservedDBInstancesOfferingList":{ - "type":"list", - "member":{ - "shape":"ReservedDBInstancesOffering", - "locationName":"ReservedDBInstancesOffering" - } - }, - "ReservedDBInstancesOfferingMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of reserved DB instance offerings.
" - } - }, - "documentation":"Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
" - }, - "ReservedDBInstancesOfferingNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedDBInstancesOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - }, - "ResetDBParameterGroupMessage":{ - "type":"structure", - "required":["DBParameterGroupName"], - "members":{ - "DBParameterGroupName":{ - "shape":"String", - "documentation":"The name of the DB parameter group.
Constraints:
Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
Default: true
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
" - }, - "ResourceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ResourceNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"
The specified Resource ID was not found.
" - }, - "ResourcePendingMaintenanceActions":{ - "type":"structure", - "members":{ - "ResourceIdentifier":{ - "shape":"String", - "documentation":"The ARN of this resource that has pending maintenance actions.
" - }, - "PendingMaintenanceActionDetails":{ - "shape":"PendingMaintenanceActionDetails", - "documentation":"Provides details about the pending maintenance actions for the resource.
" - } - }, - "wrapper":true, - "documentation":"Describes the pending maintenance actions for a resource.
" - }, - "RestoreDBInstanceFromDBSnapshotMessage":{ - "type":"structure", - "required":[ - "DBInstanceIdentifier", - "DBSnapshotIdentifier" - ], - "members":{ - "DBInstanceIdentifier":{ - "shape":"String", - "documentation":"Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":"Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "Tags":{"shape":"TagList"}, - "StorageType":{ - "shape":"String", - "documentation":"Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "RestoreDBInstanceToPointInTimeMessage":{ - "type":"structure", - "required":[ - "SourceDBInstanceIdentifier", - "TargetDBInstanceIdentifier" - ], - "members":{ - "SourceDBInstanceIdentifier":{ - "shape":"String", - "documentation":"
The identifier of the source DB instance from which to restore.
Constraints:
The name of the new database instance to be created.
Constraints:
The date and time to restore from.
Valid Values: Value must be a UTC time
Constraints:
Example: 2009-09-07T23:45:00Z
Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
" - }, - "DBInstanceClass":{ - "shape":"String", - "documentation":"The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: The same DBInstanceClass as the original DB instance.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
" - }, - "MultiAZ":{ - "shape":"BooleanOptional", - "documentation":"Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
" - }, - "AutoMinorVersionUpgrade":{ - "shape":"BooleanOptional", - "documentation":"Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
" - }, - "LicenseModel":{ - "shape":"String", - "documentation":"License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter is not used for the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" - }, - "OptionGroupName":{ - "shape":"String", - "documentation":"The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
" - }, - "Tags":{"shape":"TagList"}, - "StorageType":{ - "shape":"String", - "documentation":"Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
" - }, - "TdeCredentialPassword":{ - "shape":"String", - "documentation":"The password for the given ARN from the Key Store in order to access the device.
" - } - }, - "documentation":"" - }, - "RevokeDBSecurityGroupIngressMessage":{ - "type":"structure", - "required":["DBSecurityGroupName"], - "members":{ - "DBSecurityGroupName":{ - "shape":"String", - "documentation":"
The name of the DB security group to revoke ingress from.
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":" The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
" - }, - "SNSInvalidTopicFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
SNS has responded that there is a problem with the SND topic specified.
" - }, - "SNSNoAuthorizationFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the SNS topic ARN.
" - }, - "SNSTopicArnNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The SNS topic ARN does not exist.
" - }, - "SnapshotQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
" - }, - "SourceIdsList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SourceId" - } - }, - "SourceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The requested source could not be found.
" - }, - "SourceType":{ - "type":"string", - "enum":[ - "db-instance", - "db-parameter-group", - "db-security-group", - "db-snapshot" - ] - }, - "StorageQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"StorageQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
" - }, - "StorageTypeNotSupportedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"StorageTypeNotSupported", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"StorageType specified cannot be associated with the DB Instance.
" - }, - "String":{"type":"string"}, - "Subnet":{ - "type":"structure", - "members":{ - "SubnetIdentifier":{ - "shape":"String", - "documentation":"Specifies the identifier of the subnet.
" - }, - "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, - "SubnetStatus":{ - "shape":"String", - "documentation":"Specifies the status of the subnet.
" - } - }, - "documentation":"This data type is used as a response element in the DescribeDBSubnetGroups action.
" - }, - "SubnetAlreadyInUse":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubnetAlreadyInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The DB subnet is already in use in the Availability Zone.
" - }, - "SubnetIdentifierList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SubnetIdentifier" - } - }, - "SubnetList":{ - "type":"list", - "member":{ - "shape":"Subnet", - "locationName":"Subnet" - } - }, - "SubscriptionAlreadyExistFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionAlreadyExist", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied subscription name already exists.
" - }, - "SubscriptionCategoryNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The supplied category does not exist.
" - }, - "SubscriptionNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription name does not exist.
" - }, - "SupportedCharacterSetsList":{ - "type":"list", - "member":{ - "shape":"CharacterSet", - "locationName":"CharacterSet" - } - }, - "TStamp":{"type":"timestamp"}, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
" - }, - "Value":{ - "shape":"String", - "documentation":"A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
" - } - }, - "documentation":"Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" - }, - "TagList":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"Tag" - }, - "documentation":"A list of tags.
" - }, - "TagListMessage":{ - "type":"structure", - "members":{ - "TagList":{ - "shape":"TagList", - "documentation":"List of tags returned by the ListTagsForResource operation.
" - } - }, - "documentation":"" - }, - "VpcSecurityGroupIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpcSecurityGroupId" - } - }, - "VpcSecurityGroupMembership":{ - "type":"structure", - "members":{ - "VpcSecurityGroupId":{ - "shape":"String", - "documentation":"The name of the VPC security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the VPC security group.
" - } - }, - "documentation":"This data type is used as a response element for queries on VPC security group membership.
" - }, - "VpcSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"VpcSecurityGroupMembership", - "locationName":"VpcSecurityGroupMembership" - } - }, - "AddSourceIdentifierToSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "ApplyPendingMaintenanceActionResult":{ - "type":"structure", - "members":{ - "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} - } - }, - "AuthorizeDBSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "DBSecurityGroup":{"shape":"DBSecurityGroup"} - } - }, - "CopyDBParameterGroupResult":{ - "type":"structure", - "members":{ - "DBParameterGroup":{"shape":"DBParameterGroup"} - } - }, - "CopyDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBSnapshot":{"shape":"DBSnapshot"} - } - }, - "CopyOptionGroupResult":{ - "type":"structure", - "members":{ - "OptionGroup":{"shape":"OptionGroup"} - } - }, - "CreateDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "CreateDBInstanceReadReplicaResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "CreateDBParameterGroupResult":{ - "type":"structure", - "members":{ - "DBParameterGroup":{"shape":"DBParameterGroup"} - } - }, - "CreateDBSecurityGroupResult":{ - "type":"structure", - "members":{ - "DBSecurityGroup":{"shape":"DBSecurityGroup"} - } - }, - "CreateDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBSnapshot":{"shape":"DBSnapshot"} - } - }, - "CreateDBSubnetGroupResult":{ - "type":"structure", - "members":{ - "DBSubnetGroup":{"shape":"DBSubnetGroup"} - } - }, - "CreateEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "CreateOptionGroupResult":{ - "type":"structure", - "members":{ - "OptionGroup":{"shape":"OptionGroup"} - } - }, - "DeleteDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "DeleteDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBSnapshot":{"shape":"DBSnapshot"} - } - }, - "DeleteEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "DescribeEngineDefaultParametersResult":{ - "type":"structure", - "members":{ - "EngineDefaults":{"shape":"EngineDefaults"} - } - }, - "ModifyDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "ModifyDBSubnetGroupResult":{ - "type":"structure", - "members":{ - "DBSubnetGroup":{"shape":"DBSubnetGroup"} - } - }, - "ModifyEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "ModifyOptionGroupResult":{ - "type":"structure", - "members":{ - "OptionGroup":{"shape":"OptionGroup"} - } - }, - "PromoteReadReplicaResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "PurchaseReservedDBInstancesOfferingResult":{ - "type":"structure", - "members":{ - "ReservedDBInstance":{"shape":"ReservedDBInstance"} - } - }, - "RebootDBInstanceResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "RemoveSourceIdentifierFromSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "RestoreDBInstanceFromDBSnapshotResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "RestoreDBInstanceToPointInTimeResult":{ - "type":"structure", - "members":{ - "DBInstance":{"shape":"DBInstance"} - } - }, - "RevokeDBSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "DBSecurityGroup":{"shape":"DBSecurityGroup"} - } - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.paginators.json deleted file mode 100644 index 76c4f3a119..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.paginators.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "pagination": { - "DescribeDBEngineVersions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBEngineVersions" - }, - "DescribeDBInstances": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBInstances" - }, - "DescribeDBLogFiles": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DescribeDBLogFiles" - }, - "DescribeDBParameterGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBParameterGroups" - }, - "DescribeDBParameters": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Parameters" - }, - "DescribeDBSecurityGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBSecurityGroups" - }, - "DescribeDBSnapshots": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBSnapshots" - }, - "DescribeDBSubnetGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "DBSubnetGroups" - }, - "DescribeEngineDefaultParameters": { - "input_token": "Marker", - "output_token": "EngineDefaults.Marker", - "limit_key": "MaxRecords", - "result_key": "EngineDefaults.Parameters" - }, - "DescribeEventSubscriptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "EventSubscriptionsList" - }, - "DescribeEvents": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Events" - }, - "DescribeOptionGroupOptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OptionGroupOptions" - }, - "DescribeOptionGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OptionGroupsList" - }, - "DescribeOrderableDBInstanceOptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OrderableDBInstanceOptions" - }, - "DescribeReservedDBInstances": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedDBInstances" - }, - "DescribeReservedDBInstancesOfferings": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedDBInstancesOfferings" - }, - "DownloadDBLogFilePortion": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "NumberOfLines", - "more_results": "AdditionalDataPending", - "result_key": "LogFileData" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.waiters.json deleted file mode 100644 index b01500797d..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/rds/2014-10-31.waiters.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "version": 2, - "waiters": { - "DBInstanceAvailable": { - "delay": 30, - "operation": "DescribeDBInstances", - "maxAttempts": 60, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "failed", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-restore", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-parameters", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-parameters", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "incompatible-restore", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - } - ] - }, - "DBInstanceDeleted": { - "delay": 30, - "operation": "DescribeDBInstances", - "maxAttempts": 60, - "acceptors": [ - { - "expected": "deleted", - "matcher": "pathAll", - "state": "success", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "creating", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "modifying", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "rebooting", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - }, - { - "expected": "resetting-master-credentials", - "matcher": "pathAny", - "state": "failure", - "argument": "DBInstances[].DBInstanceStatus" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.normal.json deleted file mode 100644 index a6f1d867f2..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.normal.json +++ /dev/null @@ -1,6895 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-12-01", - "endpointPrefix":"redshift", - "serviceFullName":"Amazon Redshift", - "signatureVersion":"v4", - "xmlNamespace":"http://redshift.amazonaws.com/doc/2012-12-01/", - "protocol":"query" - }, - "documentation":"This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces .
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the The Amazon Redshift Getting Started Guide
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
", - "operations":{ - "AuthorizeClusterSecurityGroupIngress":{ - "name":"AuthorizeClusterSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AuthorizeClusterSecurityGroupIngressMessage", - "documentation":"???
" - }, - "output":{ - "shape":"AuthorizeClusterSecurityGroupIngressResult", - "wrapper":true, - "documentation":"Describes a security group.
", - "resultWrapper":"AuthorizeClusterSecurityGroupIngressResult" - }, - "errors":[ - { - "shape":"ClusterSecurityGroupNotFoundFault", - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - }, - { - "shape":"InvalidClusterSecurityGroupStateFault", - "error":{ - "code":"InvalidClusterSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The state of the cluster security group is not available.
The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
" - }, - { - "shape":"AuthorizationQuotaExceededFault", - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The authorization quota for the cluster security group has been reached.
" - } - ], - "documentation":"Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "AuthorizeSnapshotAccess":{ - "name":"AuthorizeSnapshotAccess", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AuthorizeSnapshotAccessMessage", - "documentation":"" - }, - "output":{ - "shape":"AuthorizeSnapshotAccessResult", - "wrapper":true, - "documentation":"
Describes a snapshot.
", - "resultWrapper":"AuthorizeSnapshotAccessResult" - }, - "errors":[ - { - "shape":"ClusterSnapshotNotFoundFault", - "error":{ - "code":"ClusterSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The snapshot identifier does not refer to an existing cluster snapshot.
" - }, - { - "shape":"AuthorizationAlreadyExistsFault", - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
" - }, - { - "shape":"AuthorizationQuotaExceededFault", - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The authorization quota for the cluster security group has been reached.
" - } - ], - "documentation":"Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
" - }, - "CopyClusterSnapshot":{ - "name":"CopyClusterSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CopyClusterSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"CopyClusterSnapshotResult", - "wrapper":true, - "documentation":"
Describes a snapshot.
", - "resultWrapper":"CopyClusterSnapshotResult" - }, - "errors":[ - { - "shape":"ClusterSnapshotAlreadyExistsFault", - "error":{ - "code":"ClusterSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified as a snapshot identifier is already used by an existing snapshot.
" - }, - { - "shape":"ClusterSnapshotNotFoundFault", - "error":{ - "code":"ClusterSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The snapshot identifier does not refer to an existing cluster snapshot.
" - }, - { - "shape":"InvalidClusterSnapshotStateFault", - "error":{ - "code":"InvalidClusterSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.
The request would result in the user exceeding the allowed number of cluster snapshots.
" - } - ], - "documentation":"Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateCluster":{ - "name":"CreateCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateClusterMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateClusterResult", - "wrapper":true, - "documentation":"Describes a cluster.
", - "resultWrapper":"CreateClusterResult" - }, - "errors":[ - { - "shape":"ClusterAlreadyExistsFault", - "error":{ - "code":"ClusterAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The account already has a cluster with the given identifier.
" - }, - { - "shape":"InsufficientClusterCapacityFault", - "error":{ - "code":"InsufficientClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The number of nodes specified exceeds the allotted capacity of the cluster.
" - }, - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - }, - { - "shape":"ClusterSecurityGroupNotFoundFault", - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - }, - { - "shape":"ClusterQuotaExceededFault", - "error":{ - "code":"ClusterQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"NumberOfNodesQuotaExceededFault", - "error":{ - "code":"NumberOfNodesQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"NumberOfNodesPerClusterLimitExceededFault", - "error":{ - "code":"NumberOfNodesPerClusterLimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The operation would exceed the number of nodes allowed for a cluster.
" - }, - { - "shape":"ClusterSubnetGroupNotFoundFault", - "error":{ - "code":"ClusterSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group name does not refer to an existing cluster subnet group.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group does not cover all Availability Zones.
" - }, - { - "shape":"InvalidClusterSubnetGroupStateFault", - "error":{ - "code":"InvalidClusterSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group cannot be deleted because it is in use.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is not valid, or not all of the subnets are in the same VPC.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - }, - { - "shape":"HsmClientCertificateNotFoundFault", - "error":{ - "code":"HsmClientCertificateNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM client certificate with the specified identifier.
" - }, - { - "shape":"HsmConfigurationNotFoundFault", - "error":{ - "code":"HsmConfigurationNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM configuration with the specified identifier.
" - }, - { - "shape":"InvalidElasticIpFault", - "error":{ - "code":"InvalidElasticIpFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Elastic IP (EIP) is invalid or cannot be found.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
" - }, - "CreateClusterParameterGroup":{ - "name":"CreateClusterParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateClusterParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateClusterParameterGroupResult", - "wrapper":true, - "documentation":"
Describes a parameter group.
", - "resultWrapper":"CreateClusterParameterGroupResult" - }, - "errors":[ - { - "shape":"ClusterParameterGroupQuotaExceededFault", - "error":{ - "code":"ClusterParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"ClusterParameterGroupAlreadyExistsFault", - "error":{ - "code":"ClusterParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A cluster parameter group with the same name already exists.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateClusterSecurityGroup":{ - "name":"CreateClusterSecurityGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateClusterSecurityGroupMessage", - "documentation":"???
" - }, - "output":{ - "shape":"CreateClusterSecurityGroupResult", - "wrapper":true, - "documentation":"Describes a security group.
", - "resultWrapper":"CreateClusterSecurityGroupResult" - }, - "errors":[ - { - "shape":"ClusterSecurityGroupAlreadyExistsFault", - "error":{ - "code":"ClusterSecurityGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A cluster security group with the same name already exists.
" - }, - { - "shape":"ClusterSecurityGroupQuotaExceededFault", - "error":{ - "code":"QuotaExceeded.ClusterSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateClusterSnapshot":{ - "name":"CreateClusterSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateClusterSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateClusterSnapshotResult", - "wrapper":true, - "documentation":"
Describes a snapshot.
", - "resultWrapper":"CreateClusterSnapshotResult" - }, - "errors":[ - { - "shape":"ClusterSnapshotAlreadyExistsFault", - "error":{ - "code":"ClusterSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified as a snapshot identifier is already used by an existing snapshot.
" - }, - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"ClusterSnapshotQuotaExceededFault", - "error":{ - "code":"ClusterSnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster snapshots.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":" Creates a manual snapshot of the specified cluster. The cluster must be in the available state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateClusterSubnetGroup":{ - "name":"CreateClusterSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateClusterSubnetGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateClusterSubnetGroupResult", - "wrapper":true, - "documentation":"
Describes a subnet group.
", - "resultWrapper":"CreateClusterSubnetGroupResult" - }, - "errors":[ - { - "shape":"ClusterSubnetGroupAlreadyExistsFault", - "error":{ - "code":"ClusterSubnetGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A ClusterSubnetGroupName is already used by an existing cluster subnet group.
" - }, - { - "shape":"ClusterSubnetGroupQuotaExceededFault", - "error":{ - "code":"ClusterSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"ClusterSubnetQuotaExceededFault", - "error":{ - "code":"ClusterSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is not valid, or not all of the subnets are in the same VPC.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateEventSubscription":{ - "name":"CreateEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateEventSubscriptionResult", - "wrapper":true, - "resultWrapper":"CreateEventSubscriptionResult" - }, - "errors":[ - { - "shape":"EventSubscriptionQuotaExceededFault", - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"SubscriptionAlreadyExistFault", - "error":{ - "code":"SubscriptionAlreadyExist", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is already an existing event notification subscription with the specified name.
" - }, - { - "shape":"SNSInvalidTopicFault", - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
" - }, - { - "shape":"SNSNoAuthorizationFault", - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the specified Amazon SNS topic.
" - }, - { - "shape":"SNSTopicArnNotFoundFault", - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
" - }, - { - "shape":"SubscriptionEventIdNotFoundFault", - "error":{ - "code":"SubscriptionEventIdNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event with the specified event ID does not exist.
" - }, - { - "shape":"SubscriptionCategoryNotFoundFault", - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
" - }, - { - "shape":"SubscriptionSeverityNotFoundFault", - "error":{ - "code":"SubscriptionSeverityNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon Redshift event source could not be found.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
" - }, - "CreateHsmClientCertificate":{ - "name":"CreateHsmClientCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateHsmClientCertificateMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateHsmClientCertificateResult", - "wrapper":true, - "documentation":"Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
", - "resultWrapper":"CreateHsmClientCertificateResult" - }, - "errors":[ - { - "shape":"HsmClientCertificateAlreadyExistsFault", - "error":{ - "code":"HsmClientCertificateAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
" - }, - { - "shape":"HsmClientCertificateQuotaExceededFault", - "error":{ - "code":"HsmClientCertificateQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateHsmConfiguration":{ - "name":"CreateHsmConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateHsmConfigurationMessage", - "documentation":"" - }, - "output":{ - "shape":"CreateHsmConfigurationResult", - "wrapper":true, - "documentation":"Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
", - "resultWrapper":"CreateHsmConfigurationResult" - }, - "errors":[ - { - "shape":"HsmConfigurationAlreadyExistsFault", - "error":{ - "code":"HsmConfigurationAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is already an existing Amazon Redshift HSM configuration with the specified identifier.
" - }, - { - "shape":"HsmConfigurationQuotaExceededFault", - "error":{ - "code":"HsmConfigurationQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"TagLimitExceededFault", - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
" - }, - "CreateTags":{ - "name":"CreateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateTagsMessage", - "documentation":" Contains the output from the CreateTags action.
The request exceeds the limit of 10 tags for the resource.
" - }, - { - "shape":"ResourceNotFoundFault", - "error":{ - "code":"ResourceNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The resource could not be found.
" - }, - { - "shape":"InvalidTagFault", - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - } - ], - "documentation":"Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
" - }, - "DeleteCluster":{ - "name":"DeleteCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteClusterMessage", - "documentation":"" - }, - "output":{ - "shape":"DeleteClusterResult", - "wrapper":true, - "documentation":"
Describes a cluster.
", - "resultWrapper":"DeleteClusterResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
The value specified as a snapshot identifier is already used by an existing snapshot.
" - }, - { - "shape":"ClusterSnapshotQuotaExceededFault", - "error":{ - "code":"ClusterSnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster snapshots.
" - } - ], - "documentation":"Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
" - }, - "DeleteClusterParameterGroup":{ - "name":"DeleteClusterParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteClusterParameterGroupMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"InvalidClusterParameterGroupStateFault", - "error":{ - "code":"InvalidClusterParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
" - }, - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - } - ], - "documentation":" Deletes a specified Amazon Redshift parameter group.
" - }, - "errors":[ - { - "shape":"InvalidClusterSecurityGroupStateFault", - "error":{ - "code":"InvalidClusterSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The state of the cluster security group is not available.
The cluster security group name does not refer to an existing cluster security group.
" - } - ], - "documentation":"Deletes an Amazon Redshift security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "DeleteClusterSnapshot":{ - "name":"DeleteClusterSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteClusterSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"DeleteClusterSnapshotResult", - "wrapper":true, - "documentation":"
Describes a snapshot.
", - "resultWrapper":"DeleteClusterSnapshotResult" - }, - "errors":[ - { - "shape":"InvalidClusterSnapshotStateFault", - "error":{ - "code":"InvalidClusterSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.
The snapshot identifier does not refer to an existing cluster snapshot.
" - } - ], - "documentation":" Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
" - }, - "DeleteClusterSubnetGroup":{ - "name":"DeleteClusterSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteClusterSubnetGroupMessage"}, - "errors":[ - { - "shape":"InvalidClusterSubnetGroupStateFault", - "error":{ - "code":"InvalidClusterSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group cannot be deleted because it is in use.
" - }, - { - "shape":"InvalidClusterSubnetStateFault", - "error":{ - "code":"InvalidClusterSubnetStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the subnet is invalid.
" - }, - { - "shape":"ClusterSubnetGroupNotFoundFault", - "error":{ - "code":"ClusterSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group name does not refer to an existing cluster subnet group.
" - } - ], - "documentation":"Deletes the specified cluster subnet group.
" - }, - "DeleteEventSubscription":{ - "name":"DeleteEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteEventSubscriptionMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event notification subscription with the specified name does not exist.
" - }, - { - "shape":"InvalidSubscriptionStateFault", - "error":{ - "code":"InvalidSubscriptionStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
" - } - ], - "documentation":"Deletes an Amazon Redshift event notification subscription.
" - }, - "DeleteHsmClientCertificate":{ - "name":"DeleteHsmClientCertificate", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteHsmClientCertificateMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"InvalidHsmClientCertificateStateFault", - "error":{ - "code":"InvalidHsmClientCertificateStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
There is no Amazon Redshift HSM client certificate with the specified identifier.
" - } - ], - "documentation":"Deletes the specified HSM client certificate.
" - }, - "DeleteHsmConfiguration":{ - "name":"DeleteHsmConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteHsmConfigurationMessage", - "documentation":"" - }, - "errors":[ - { - "shape":"InvalidHsmConfigurationStateFault", - "error":{ - "code":"InvalidHsmConfigurationStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
There is no Amazon Redshift HSM configuration with the specified identifier.
" - } - ], - "documentation":"Deletes the specified Amazon Redshift HSM configuration.
" - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteTagsMessage", - "documentation":" Contains the output from the DeleteTags action.
The resource could not be found.
" - } - ], - "documentation":"Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
" - }, - "DescribeClusterParameterGroups":{ - "name":"DescribeClusterParameterGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeClusterParameterGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"ClusterParameterGroupsMessage", - "documentation":"
Contains the output from the DescribeClusterParameterGroups action.
", - "resultWrapper":"DescribeClusterParameterGroupsResult" - }, - "errors":[ - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - } - ], - "documentation":"Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeClusterParameters":{ - "name":"DescribeClusterParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterParametersMessage"}, - "output":{ - "shape":"ClusterParameterGroupDetails", - "documentation":"Contains the output from the DescribeClusterParameters action.
", - "resultWrapper":"DescribeClusterParametersResult" - }, - "errors":[ - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - } - ], - "documentation":"Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "DescribeClusterSecurityGroups":{ - "name":"DescribeClusterSecurityGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeClusterSecurityGroupsMessage", - "documentation":"???
" - }, - "output":{ - "shape":"ClusterSecurityGroupMessage", - "documentation":"Contains the output from the DescribeClusterSecurityGroups action.
", - "resultWrapper":"DescribeClusterSecurityGroupsResult" - }, - "errors":[ - { - "shape":"ClusterSecurityGroupNotFoundFault", - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - } - ], - "documentation":"Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeClusterSnapshots":{ - "name":"DescribeClusterSnapshots", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeClusterSnapshotsMessage", - "documentation":"" - }, - "output":{ - "shape":"SnapshotMessage", - "documentation":"
Contains the output from the DescribeClusterSnapshots action.
", - "resultWrapper":"DescribeClusterSnapshotsResult" - }, - "errors":[ - { - "shape":"ClusterSnapshotNotFoundFault", - "error":{ - "code":"ClusterSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The snapshot identifier does not refer to an existing cluster snapshot.
" - } - ], - "documentation":"Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeClusterSubnetGroups":{ - "name":"DescribeClusterSubnetGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeClusterSubnetGroupsMessage", - "documentation":"" - }, - "output":{ - "shape":"ClusterSubnetGroupMessage", - "documentation":"
Contains the output from the DescribeClusterSubnetGroups action.
", - "resultWrapper":"DescribeClusterSubnetGroupsResult" - }, - "errors":[ - { - "shape":"ClusterSubnetGroupNotFoundFault", - "error":{ - "code":"ClusterSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group name does not refer to an existing cluster subnet group.
" - } - ], - "documentation":"Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeClusterVersions":{ - "name":"DescribeClusterVersions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeClusterVersionsMessage"}, - "output":{ - "shape":"ClusterVersionsMessage", - "documentation":"Contains the output from the DescribeClusterVersions action.
", - "resultWrapper":"DescribeClusterVersionsResult" - }, - "documentation":"Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
" - }, - "DescribeClusters":{ - "name":"DescribeClusters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeClustersMessage", - "documentation":"" - }, - "output":{ - "shape":"ClustersMessage", - "documentation":"
Contains the output from the DescribeClusters action.
", - "resultWrapper":"DescribeClustersResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - } - ], - "documentation":"Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeDefaultClusterParameters":{ - "name":"DescribeDefaultClusterParameters", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeDefaultClusterParametersMessage", - "documentation":"" - }, - "output":{ - "shape":"DescribeDefaultClusterParametersResult", - "wrapper":true, - "documentation":"
Describes the default cluster parameters for a parameter group family.
", - "resultWrapper":"DescribeDefaultClusterParametersResult" - }, - "documentation":"Returns a list of parameter settings for the specified parameter group family.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "DescribeEventCategories":{ - "name":"DescribeEventCategories", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventCategoriesMessage", - "documentation":"" - }, - "output":{ - "shape":"EventCategoriesMessage", - "documentation":"
", - "resultWrapper":"DescribeEventCategoriesResult" - }, - "documentation":"
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
" - }, - "DescribeEventSubscriptions":{ - "name":"DescribeEventSubscriptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventSubscriptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"EventSubscriptionsMessage", - "documentation":"", - "resultWrapper":"DescribeEventSubscriptionsResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event notification subscription with the specified name does not exist.
" - } - ], - "documentation":"Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.
" - }, - "DescribeEvents":{ - "name":"DescribeEvents", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeEventsMessage", - "documentation":"" - }, - "output":{ - "shape":"EventsMessage", - "documentation":"
Contains the output from the DescribeEvents action.
", - "resultWrapper":"DescribeEventsResult" - }, - "documentation":"Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
" - }, - "DescribeHsmClientCertificates":{ - "name":"DescribeHsmClientCertificates", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeHsmClientCertificatesMessage", - "documentation":"" - }, - "output":{ - "shape":"HsmClientCertificateMessage", - "documentation":"", - "resultWrapper":"DescribeHsmClientCertificatesResult" - }, - "errors":[ - { - "shape":"HsmClientCertificateNotFoundFault", - "error":{ - "code":"HsmClientCertificateNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM client certificate with the specified identifier.
" - } - ], - "documentation":"Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeHsmConfigurations":{ - "name":"DescribeHsmConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeHsmConfigurationsMessage", - "documentation":"" - }, - "output":{ - "shape":"HsmConfigurationMessage", - "documentation":"", - "resultWrapper":"DescribeHsmConfigurationsResult" - }, - "errors":[ - { - "shape":"HsmConfigurationNotFoundFault", - "error":{ - "code":"HsmConfigurationNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM configuration with the specified identifier.
" - } - ], - "documentation":"Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DescribeLoggingStatus":{ - "name":"DescribeLoggingStatus", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeLoggingStatusMessage", - "documentation":"" - }, - "output":{ - "shape":"LoggingStatus", - "documentation":"
Describes the status of logging for a cluster.
", - "resultWrapper":"DescribeLoggingStatusResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - } - ], - "documentation":"Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
" - }, - "DescribeOrderableClusterOptions":{ - "name":"DescribeOrderableClusterOptions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeOrderableClusterOptionsMessage", - "documentation":"" - }, - "output":{ - "shape":"OrderableClusterOptionsMessage", - "documentation":"
Contains the output from the DescribeOrderableClusterOptions action.
", - "resultWrapper":"DescribeOrderableClusterOptionsResult" - }, - "documentation":"Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
" - }, - "DescribeReservedNodeOfferings":{ - "name":"DescribeReservedNodeOfferings", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedNodeOfferingsMessage", - "documentation":"to be provided.
" - }, - "output":{ - "shape":"ReservedNodeOfferingsMessage", - "documentation":"Contains the output from the DescribeReservedNodeOfferings action.
", - "resultWrapper":"DescribeReservedNodeOfferingsResult" - }, - "errors":[ - { - "shape":"ReservedNodeOfferingNotFoundFault", - "error":{ - "code":"ReservedNodeOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - } - ], - "documentation":"Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
" - }, - "DescribeReservedNodes":{ - "name":"DescribeReservedNodes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeReservedNodesMessage", - "documentation":"" - }, - "output":{ - "shape":"ReservedNodesMessage", - "documentation":"
Contains the output from the DescribeReservedNodes action.
", - "resultWrapper":"DescribeReservedNodesResult" - }, - "errors":[ - { - "shape":"ReservedNodeNotFoundFault", - "error":{ - "code":"ReservedNodeNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified reserved compute node not found.
" - } - ], - "documentation":"Returns the descriptions of the reserved nodes.
" - }, - "DescribeResize":{ - "name":"DescribeResize", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeResizeMessage", - "documentation":"" - }, - "output":{ - "shape":"ResizeProgressMessage", - "documentation":"
Describes the result of a cluster resize operation.
", - "resultWrapper":"DescribeResizeResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"ResizeNotFoundFault", - "error":{ - "code":"ResizeNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"A resize operation for the specified cluster is not found.
" - } - ], - "documentation":" Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
" - }, - "DescribeTags":{ - "name":"DescribeTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeTagsMessage", - "documentation":" Contains the output from the DescribeTags action.
Contains the output from the DescribeTags action.
The resource could not be found.
" - } - ], - "documentation":"Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
MaxRecords and Marker parameters together with the ARN parameter.MaxRecords parameter can be a range from 10 to 50 results to return in a request.If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
" - }, - "DisableLogging":{ - "name":"DisableLogging", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DisableLoggingMessage", - "documentation":"" - }, - "output":{ - "shape":"LoggingStatus", - "documentation":"
Describes the status of logging for a cluster.
", - "resultWrapper":"DisableLoggingResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - } - ], - "documentation":"Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
" - }, - "DisableSnapshotCopy":{ - "name":"DisableSnapshotCopy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DisableSnapshotCopyMessage", - "documentation":"" - }, - "output":{ - "shape":"DisableSnapshotCopyResult", - "wrapper":true, - "documentation":"
Describes a cluster.
", - "resultWrapper":"DisableSnapshotCopyResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"SnapshotCopyAlreadyDisabledFault", - "error":{ - "code":"SnapshotCopyAlreadyDisabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster already has cross-region snapshot copy disabled.
" - }, - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
Your account is not authorized to perform the requested operation.
" - } - ], - "documentation":"Disables the automatic copying of snapshots from one region to another region for a specified cluster.
" - }, - "EnableLogging":{ - "name":"EnableLogging", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"EnableLoggingMessage", - "documentation":"" - }, - "output":{ - "shape":"LoggingStatus", - "documentation":"
Describes the status of logging for a cluster.
", - "resultWrapper":"EnableLoggingResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"BucketNotFoundFault", - "error":{ - "code":"BucketNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Could not find the specified S3 bucket.
" - }, - { - "shape":"InsufficientS3BucketPolicyFault", - "error":{ - "code":"InsufficientS3BucketPolicyFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
" - }, - { - "shape":"InvalidS3KeyPrefixFault", - "error":{ - "code":"InvalidS3KeyPrefixFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The string specified for the logging S3 key prefix does not comply with the documented constraints.
" - }, - { - "shape":"InvalidS3BucketNameFault", - "error":{ - "code":"InvalidS3BucketNameFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
" - } - ], - "documentation":"Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
" - }, - "EnableSnapshotCopy":{ - "name":"EnableSnapshotCopy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"EnableSnapshotCopyMessage", - "documentation":"" - }, - "output":{ - "shape":"EnableSnapshotCopyResult", - "wrapper":true, - "documentation":"
Describes a cluster.
", - "resultWrapper":"EnableSnapshotCopyResult" - }, - "errors":[ - { - "shape":"IncompatibleOrderableOptions", - "error":{ - "code":"IncompatibleOrderableOptions", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified options are incompatible.
" - }, - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"CopyToRegionDisabledFault", - "error":{ - "code":"CopyToRegionDisabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cross-region snapshot copy was temporarily disabled. Try your request again.
" - }, - { - "shape":"SnapshotCopyAlreadyEnabledFault", - "error":{ - "code":"SnapshotCopyAlreadyEnabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster already has cross-region snapshot copy enabled.
" - }, - { - "shape":"UnknownSnapshotCopyRegionFault", - "error":{ - "code":"UnknownSnapshotCopyRegionFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified region is incorrect or does not exist.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - } - ], - "documentation":"Enables the automatic copy of snapshots from one region to another region for a specified cluster.
" - }, - "ModifyCluster":{ - "name":"ModifyCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyClusterMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyClusterResult", - "wrapper":true, - "documentation":"Describes a cluster.
", - "resultWrapper":"ModifyClusterResult" - }, - "errors":[ - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
The state of the cluster security group is not available.
The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"NumberOfNodesQuotaExceededFault", - "error":{ - "code":"NumberOfNodesQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"ClusterSecurityGroupNotFoundFault", - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - }, - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - }, - { - "shape":"InsufficientClusterCapacityFault", - "error":{ - "code":"InsufficientClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The number of nodes specified exceeds the allotted capacity of the cluster.
" - }, - { - "shape":"UnsupportedOptionFault", - "error":{ - "code":"UnsupportedOptionFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A request option was specified that is not supported.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - }, - { - "shape":"HsmClientCertificateNotFoundFault", - "error":{ - "code":"HsmClientCertificateNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM client certificate with the specified identifier.
" - }, - { - "shape":"HsmConfigurationNotFoundFault", - "error":{ - "code":"HsmConfigurationNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM configuration with the specified identifier.
" - }, - { - "shape":"ClusterAlreadyExistsFault", - "error":{ - "code":"ClusterAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The account already has a cluster with the given identifier.
" - } - ], - "documentation":"Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
" - }, - "ModifyClusterParameterGroup":{ - "name":"ModifyClusterParameterGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyClusterParameterGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"ClusterParameterGroupNameMessage", - "documentation":"
Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
", - "resultWrapper":"ModifyClusterParameterGroupResult" - }, - "errors":[ - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - }, - { - "shape":"InvalidClusterParameterGroupStateFault", - "error":{ - "code":"InvalidClusterParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
" - } - ], - "documentation":"Modifies the parameters of a parameter group.
For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "ModifyClusterSubnetGroup":{ - "name":"ModifyClusterSubnetGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyClusterSubnetGroupMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyClusterSubnetGroupResult", - "wrapper":true, - "documentation":"
Describes a subnet group.
", - "resultWrapper":"ModifyClusterSubnetGroupResult" - }, - "errors":[ - { - "shape":"ClusterSubnetGroupNotFoundFault", - "error":{ - "code":"ClusterSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group name does not refer to an existing cluster subnet group.
" - }, - { - "shape":"ClusterSubnetQuotaExceededFault", - "error":{ - "code":"ClusterSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"SubnetAlreadyInUse", - "error":{ - "code":"SubnetAlreadyInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A specified subnet is already in use by another cluster.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is not valid, or not all of the subnets are in the same VPC.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - } - ], - "documentation":"Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
" - }, - "ModifyEventSubscription":{ - "name":"ModifyEventSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifyEventSubscriptionMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifyEventSubscriptionResult", - "wrapper":true, - "resultWrapper":"ModifyEventSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionNotFoundFault", - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event notification subscription with the specified name does not exist.
" - }, - { - "shape":"SNSInvalidTopicFault", - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
" - }, - { - "shape":"SNSNoAuthorizationFault", - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the specified Amazon SNS topic.
" - }, - { - "shape":"SNSTopicArnNotFoundFault", - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
" - }, - { - "shape":"SubscriptionEventIdNotFoundFault", - "error":{ - "code":"SubscriptionEventIdNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event with the specified event ID does not exist.
" - }, - { - "shape":"SubscriptionCategoryNotFoundFault", - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
" - }, - { - "shape":"SubscriptionSeverityNotFoundFault", - "error":{ - "code":"SubscriptionSeverityNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
" - }, - { - "shape":"SourceNotFoundFault", - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon Redshift event source could not be found.
" - }, - { - "shape":"InvalidSubscriptionStateFault", - "error":{ - "code":"InvalidSubscriptionStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
" - } - ], - "documentation":"Modifies an existing Amazon Redshift event notification subscription.
" - }, - "ModifySnapshotCopyRetentionPeriod":{ - "name":"ModifySnapshotCopyRetentionPeriod", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ModifySnapshotCopyRetentionPeriodMessage", - "documentation":"" - }, - "output":{ - "shape":"ModifySnapshotCopyRetentionPeriodResult", - "wrapper":true, - "documentation":"
Describes a cluster.
", - "resultWrapper":"ModifySnapshotCopyRetentionPeriodResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"SnapshotCopyDisabledFault", - "error":{ - "code":"SnapshotCopyDisabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cross-region snapshot copy was temporarily disabled. Try your request again.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - }, - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
" - }, - "PurchaseReservedNodeOffering":{ - "name":"PurchaseReservedNodeOffering", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"PurchaseReservedNodeOfferingMessage", - "documentation":"" - }, - "output":{ - "shape":"PurchaseReservedNodeOfferingResult", - "wrapper":true, - "documentation":"Describes a reserved node.
", - "resultWrapper":"PurchaseReservedNodeOfferingResult" - }, - "errors":[ - { - "shape":"ReservedNodeOfferingNotFoundFault", - "error":{ - "code":"ReservedNodeOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - }, - { - "shape":"ReservedNodeAlreadyExistsFault", - "error":{ - "code":"ReservedNodeAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a reservation with the given identifier.
" - }, - { - "shape":"ReservedNodeQuotaExceededFault", - "error":{ - "code":"ReservedNodeQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - } - ], - "documentation":"Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
" - }, - "RebootCluster":{ - "name":"RebootCluster", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RebootClusterMessage", - "documentation":"" - }, - "output":{ - "shape":"RebootClusterResult", - "wrapper":true, - "documentation":"
Describes a cluster.
", - "resultWrapper":"RebootClusterResult" - }, - "errors":[ - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
The ClusterIdentifier parameter does not refer to an existing cluster.
" - } - ], - "documentation":" Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
" - }, - "output":{ - "shape":"ClusterParameterGroupNameMessage", - "documentation":"
Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
", - "resultWrapper":"ResetClusterParameterGroupResult" - }, - "errors":[ - { - "shape":"InvalidClusterParameterGroupStateFault", - "error":{ - "code":"InvalidClusterParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
" - }, - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - } - ], - "documentation":"Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to \"engine-default\". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
" - }, - "RestoreFromClusterSnapshot":{ - "name":"RestoreFromClusterSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RestoreFromClusterSnapshotMessage", - "documentation":"" - }, - "output":{ - "shape":"RestoreFromClusterSnapshotResult", - "wrapper":true, - "documentation":"Describes a cluster.
", - "resultWrapper":"RestoreFromClusterSnapshotResult" - }, - "errors":[ - { - "shape":"AccessToSnapshotDeniedFault", - "error":{ - "code":"AccessToSnapshotDenied", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The owner of the specified snapshot has not authorized your account to access the snapshot.
" - }, - { - "shape":"ClusterAlreadyExistsFault", - "error":{ - "code":"ClusterAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The account already has a cluster with the given identifier.
" - }, - { - "shape":"ClusterSnapshotNotFoundFault", - "error":{ - "code":"ClusterSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The snapshot identifier does not refer to an existing cluster snapshot.
" - }, - { - "shape":"ClusterQuotaExceededFault", - "error":{ - "code":"ClusterQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"InsufficientClusterCapacityFault", - "error":{ - "code":"InsufficientClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The number of nodes specified exceeds the allotted capacity of the cluster.
" - }, - { - "shape":"InvalidClusterSnapshotStateFault", - "error":{ - "code":"InvalidClusterSnapshotState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.
The restore is invalid.
" - }, - { - "shape":"NumberOfNodesQuotaExceededFault", - "error":{ - "code":"NumberOfNodesQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - { - "shape":"NumberOfNodesPerClusterLimitExceededFault", - "error":{ - "code":"NumberOfNodesPerClusterLimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The operation would exceed the number of nodes allowed for a cluster.
" - }, - { - "shape":"InvalidVPCNetworkStateFault", - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group does not cover all Availability Zones.
" - }, - { - "shape":"InvalidClusterSubnetGroupStateFault", - "error":{ - "code":"InvalidClusterSubnetGroupStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group cannot be deleted because it is in use.
" - }, - { - "shape":"InvalidSubnet", - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is not valid, or not all of the subnets are in the same VPC.
" - }, - { - "shape":"ClusterSubnetGroupNotFoundFault", - "error":{ - "code":"ClusterSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group name does not refer to an existing cluster subnet group.
" - }, - { - "shape":"UnauthorizedOperation", - "error":{ - "code":"UnauthorizedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Your account is not authorized to perform the requested operation.
" - }, - { - "shape":"HsmClientCertificateNotFoundFault", - "error":{ - "code":"HsmClientCertificateNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM client certificate with the specified identifier.
" - }, - { - "shape":"HsmConfigurationNotFoundFault", - "error":{ - "code":"HsmConfigurationNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM configuration with the specified identifier.
" - }, - { - "shape":"InvalidElasticIpFault", - "error":{ - "code":"InvalidElasticIpFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Elastic IP (EIP) is invalid or cannot be found.
" - }, - { - "shape":"ClusterParameterGroupNotFoundFault", - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - }, - { - "shape":"ClusterSecurityGroupNotFoundFault", - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - } - ], - "documentation":"Creates a new cluster from a snapshot. Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter group. After Amazon Redshift creates the cluster you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
" - }, - "RevokeClusterSecurityGroupIngress":{ - "name":"RevokeClusterSecurityGroupIngress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RevokeClusterSecurityGroupIngressMessage", - "documentation":"???
" - }, - "output":{ - "shape":"RevokeClusterSecurityGroupIngressResult", - "wrapper":true, - "documentation":"Describes a security group.
", - "resultWrapper":"RevokeClusterSecurityGroupIngressResult" - }, - "errors":[ - { - "shape":"ClusterSecurityGroupNotFoundFault", - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
" - }, - { - "shape":"InvalidClusterSecurityGroupStateFault", - "error":{ - "code":"InvalidClusterSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The state of the cluster security group is not available.
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
" - }, - "RevokeSnapshotAccess":{ - "name":"RevokeSnapshotAccess", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RevokeSnapshotAccessMessage", - "documentation":"" - }, - "output":{ - "shape":"RevokeSnapshotAccessResult", - "wrapper":true, - "documentation":"
Describes a snapshot.
", - "resultWrapper":"RevokeSnapshotAccessResult" - }, - "errors":[ - { - "shape":"AccessToSnapshotDeniedFault", - "error":{ - "code":"AccessToSnapshotDenied", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The owner of the specified snapshot has not authorized your account to access the snapshot.
" - }, - { - "shape":"AuthorizationNotFoundFault", - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
" - }, - { - "shape":"ClusterSnapshotNotFoundFault", - "error":{ - "code":"ClusterSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The snapshot identifier does not refer to an existing cluster snapshot.
" - } - ], - "documentation":"Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
" - }, - "RotateEncryptionKey":{ - "name":"RotateEncryptionKey", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RotateEncryptionKeyMessage", - "documentation":"" - }, - "output":{ - "shape":"RotateEncryptionKeyResult", - "wrapper":true, - "documentation":"
Describes a cluster.
", - "resultWrapper":"RotateEncryptionKeyResult" - }, - "errors":[ - { - "shape":"ClusterNotFoundFault", - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - { - "shape":"InvalidClusterStateFault", - "error":{ - "code":"InvalidClusterState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The specified cluster is not in the available state.
Rotates the encryption keys for a cluster.
" - } - }, - "shapes":{ - "AccessToSnapshotDeniedFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AccessToSnapshotDenied", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The owner of the specified snapshot has not authorized your account to access the snapshot.
" - }, - "AccountWithRestoreAccess":{ - "type":"structure", - "members":{ - "AccountId":{ - "shape":"String", - "documentation":"The identifier of an AWS customer account authorized to restore a snapshot.
" - } - }, - "documentation":"Describes an AWS customer account authorized to restore a snapshot.
" - }, - "AccountsWithRestoreAccessList":{ - "type":"list", - "member":{ - "shape":"AccountWithRestoreAccess", - "locationName":"AccountWithRestoreAccess" - } - }, - "AuthorizationAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
" - }, - "AuthorizationNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
" - }, - "AuthorizationQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AuthorizationQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The authorization quota for the cluster security group has been reached.
" - }, - "AuthorizeClusterSecurityGroupIngressMessage":{ - "type":"structure", - "required":["ClusterSecurityGroupName"], - "members":{ - "ClusterSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the security group to which the ingress rule is added.
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":"The IP range to be added the Amazon Redshift security group.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"The EC2 security group to be added the Amazon Redshift security group.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":"The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
???
" - }, - "AuthorizeSnapshotAccessMessage":{ - "type":"structure", - "required":[ - "SnapshotIdentifier", - "AccountWithRestoreAccess" - ], - "members":{ - "SnapshotIdentifier":{ - "shape":"String", - "documentation":"The identifier of the snapshot the account is authorized to restore.
" - }, - "SnapshotClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
" - }, - "AccountWithRestoreAccess":{ - "shape":"String", - "documentation":"The identifier of the AWS customer account authorized to restore the specified snapshot.
" - } - }, - "documentation":"" - }, - "AvailabilityZone":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"
The name of the availability zone.
" - } - }, - "wrapper":true, - "documentation":"Describes an availability zone.
" - }, - "AvailabilityZoneList":{ - "type":"list", - "member":{ - "shape":"AvailabilityZone", - "locationName":"AvailabilityZone" - } - }, - "Boolean":{"type":"boolean"}, - "BooleanOptional":{"type":"boolean"}, - "BucketNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"BucketNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Could not find the specified S3 bucket.
" - }, - "Cluster":{ - "type":"structure", - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The unique identifier of the cluster.
" - }, - "NodeType":{ - "shape":"String", - "documentation":"The node type for the nodes in the cluster.
" - }, - "ClusterStatus":{ - "shape":"String", - "documentation":" The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
The status of a modify operation, if any, initiated for the cluster.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
" - }, - "DBName":{ - "shape":"String", - "documentation":"The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named \"dev\" was created by default.
" - }, - "Endpoint":{ - "shape":"Endpoint", - "documentation":"The connection endpoint.
" - }, - "ClusterCreateTime":{ - "shape":"TStamp", - "documentation":"The date and time that the cluster was created.
" - }, - "AutomatedSnapshotRetentionPeriod":{ - "shape":"Integer", - "documentation":"The number of days that automatic cluster snapshots are retained.
" - }, - "ClusterSecurityGroups":{ - "shape":"ClusterSecurityGroupMembershipList", - "documentation":" A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
" - }, - "VpcSecurityGroups":{ - "shape":"VpcSecurityGroupMembershipList", - "documentation":"A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
" - }, - "ClusterParameterGroups":{ - "shape":"ClusterParameterGroupStatusList", - "documentation":"The list of cluster parameter groups that are associated with this cluster.
" - }, - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The identifier of the VPC the cluster is in, if the cluster is in a VPC.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The name of the Availability Zone in which the cluster is located.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which system maintenance can occur.
" - }, - "PendingModifiedValues":{ - "shape":"PendingModifiedValues", - "documentation":"If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
" - }, - "ClusterVersion":{ - "shape":"String", - "documentation":"The version ID of the Amazon Redshift engine that is running on the cluster.
" - }, - "AllowVersionUpgrade":{ - "shape":"Boolean", - "documentation":" If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
The number of compute nodes in the cluster.
" - }, - "PubliclyAccessible":{ - "shape":"Boolean", - "documentation":"If true, the cluster can be accessed from a public network.
If true, data in the cluster is encrypted at rest.
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
" - }, - "HsmStatus":{ - "shape":"HsmStatus", - "documentation":"Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
" - }, - "ClusterSnapshotCopyStatus":{ - "shape":"ClusterSnapshotCopyStatus", - "documentation":"Returns the destination region and retention period that are configured for cross-region snapshot copy.
" - }, - "ClusterPublicKey":{ - "shape":"String", - "documentation":"The public key for the cluster.
" - }, - "ClusterNodes":{ - "shape":"ClusterNodesList", - "documentation":"The nodes in a cluster.
" - }, - "ElasticIpStatus":{ - "shape":"ElasticIpStatus", - "documentation":"Describes the status of the elastic IP (EIP) address.
" - }, - "ClusterRevisionNumber":{ - "shape":"String", - "documentation":"The specific revision number of the database in the cluster.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the cluster.
" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
" - } - }, - "wrapper":true, - "documentation":"Describes a cluster.
" - }, - "ClusterAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The account already has a cluster with the given identifier.
" - }, - "ClusterList":{ - "type":"list", - "member":{ - "shape":"Cluster", - "locationName":"Cluster" - } - }, - "ClusterNode":{ - "type":"structure", - "members":{ - "NodeRole":{ - "shape":"String", - "documentation":"Whether the node is a leader node or a compute node.
" - }, - "PrivateIPAddress":{ - "shape":"String", - "documentation":"The private IP address of a node within a cluster.
" - }, - "PublicIPAddress":{ - "shape":"String", - "documentation":"The public IP address of a node within a cluster.
" - } - }, - "documentation":"The identifier of a node in a cluster.
" - }, - "ClusterNodesList":{ - "type":"list", - "member":{"shape":"ClusterNode"} - }, - "ClusterNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The ClusterIdentifier parameter does not refer to an existing cluster.
" - }, - "ClusterParameterGroup":{ - "type":"structure", - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cluster parameter group.
" - }, - "ParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the cluster parameter group family that this cluster parameter group is compatible with.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the parameter group.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the cluster parameter group.
" - } - }, - "wrapper":true, - "documentation":"Describes a parameter group.
" - }, - "ClusterParameterGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterParameterGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A cluster parameter group with the same name already exists.
" - }, - "ClusterParameterGroupDetails":{ - "type":"structure", - "members":{ - "Parameters":{ - "shape":"ParametersList", - "documentation":"A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
" - }, - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Contains the output from the DescribeClusterParameters action.
" - }, - "ClusterParameterGroupNameMessage":{ - "type":"structure", - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cluster parameter group.
" - }, - "ParameterGroupStatus":{ - "shape":"String", - "documentation":"The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
" - } - }, - "documentation":"Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
" - }, - "ClusterParameterGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterParameterGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The parameter group name does not refer to an existing parameter group.
" - }, - "ClusterParameterGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterParameterGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "ClusterParameterGroupStatus":{ - "type":"structure", - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cluster parameter group.
" - }, - "ParameterApplyStatus":{ - "shape":"String", - "documentation":"The status of parameter updates.
" - } - }, - "documentation":"Describes the status of a parameter group.
" - }, - "ClusterParameterGroupStatusList":{ - "type":"list", - "member":{ - "shape":"ClusterParameterGroupStatus", - "locationName":"ClusterParameterGroup" - } - }, - "ClusterParameterGroupsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
" - } - }, - "documentation":"Contains the output from the DescribeClusterParameterGroups action.
" - }, - "ClusterQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "ClusterSecurityGroup":{ - "type":"structure", - "members":{ - "ClusterSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cluster security group to which the operation was applied.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the security group.
" - }, - "EC2SecurityGroups":{ - "shape":"EC2SecurityGroupList", - "documentation":"A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
" - }, - "IPRanges":{ - "shape":"IPRangeList", - "documentation":"A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the cluster security group.
" - } - }, - "wrapper":true, - "documentation":"Describes a security group.
" - }, - "ClusterSecurityGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSecurityGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A cluster security group with the same name already exists.
" - }, - "ClusterSecurityGroupMembership":{ - "type":"structure", - "members":{ - "ClusterSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the cluster security group.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the cluster security group.
" - } - }, - "documentation":"Describes a security group.
" - }, - "ClusterSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"ClusterSecurityGroupMembership", - "locationName":"ClusterSecurityGroup" - } - }, - "ClusterSecurityGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of ClusterSecurityGroup instances.
" - } - }, - "documentation":"Contains the output from the DescribeClusterSecurityGroups action.
" - }, - "ClusterSecurityGroupNameList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"ClusterSecurityGroupName" - } - }, - "ClusterSecurityGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSecurityGroupNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster security group name does not refer to an existing cluster security group.
" - }, - "ClusterSecurityGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"QuotaExceeded.ClusterSecurityGroup", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "ClusterSecurityGroups":{ - "type":"list", - "member":{ - "shape":"ClusterSecurityGroup", - "locationName":"ClusterSecurityGroup" - } - }, - "ClusterSnapshotAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSnapshotAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified as a snapshot identifier is already used by an existing snapshot.
" - }, - "ClusterSnapshotCopyStatus":{ - "type":"structure", - "members":{ - "DestinationRegion":{ - "shape":"String", - "documentation":"The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
" - }, - "RetentionPeriod":{ - "shape":"Long", - "documentation":"The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
" - } - }, - "documentation":"Returns the destination region and retention period that are configured for cross-region snapshot copy.
" - }, - "ClusterSnapshotNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSnapshotNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The snapshot identifier does not refer to an existing cluster snapshot.
" - }, - "ClusterSnapshotQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSnapshotQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in the user exceeding the allowed number of cluster snapshots.
" - }, - "ClusterSubnetGroup":{ - "type":"structure", - "members":{ - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"The name of the cluster subnet group.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the cluster subnet group.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The VPC ID of the cluster subnet group.
" - }, - "SubnetGroupStatus":{ - "shape":"String", - "documentation":" The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.
A list of the VPC Subnet elements.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the cluster subnet group.
" - } - }, - "wrapper":true, - "documentation":"Describes a subnet group.
" - }, - "ClusterSubnetGroupAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSubnetGroupAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A ClusterSubnetGroupName is already used by an existing cluster subnet group.
" - }, - "ClusterSubnetGroupMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of ClusterSubnetGroup instances.
" - } - }, - "documentation":"Contains the output from the DescribeClusterSubnetGroups action.
" - }, - "ClusterSubnetGroupNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSubnetGroupNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group name does not refer to an existing cluster subnet group.
" - }, - "ClusterSubnetGroupQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSubnetGroupQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "ClusterSubnetGroups":{ - "type":"list", - "member":{ - "shape":"ClusterSubnetGroup", - "locationName":"ClusterSubnetGroup" - } - }, - "ClusterSubnetQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ClusterSubnetQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "ClusterVersion":{ - "type":"structure", - "members":{ - "ClusterVersion":{ - "shape":"String", - "documentation":"The version number used by the cluster.
" - }, - "ClusterParameterGroupFamily":{ - "shape":"String", - "documentation":"The name of the cluster parameter group family for the cluster.
" - }, - "Description":{ - "shape":"String", - "documentation":"The description of the cluster version.
" - } - }, - "documentation":"Describes a cluster version, including the parameter group family and description of the version.
" - }, - "ClusterVersionList":{ - "type":"list", - "member":{ - "shape":"ClusterVersion", - "locationName":"ClusterVersion" - } - }, - "ClusterVersionsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of Version elements.
Contains the output from the DescribeClusterVersions action.
" - }, - "ClustersMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of Cluster objects, where each object describes one cluster.
" - } - }, - "documentation":"Contains the output from the DescribeClusters action.
" - }, - "CopyClusterSnapshotMessage":{ - "type":"structure", - "required":[ - "SourceSnapshotIdentifier", - "TargetSnapshotIdentifier" - ], - "members":{ - "SourceSnapshotIdentifier":{ - "shape":"String", - "documentation":"The identifier for the source snapshot.
Constraints:
available.The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
The identifier given to the new manual snapshot.
Constraints:
" - }, - "CopyToRegionDisabledFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"CopyToRegionDisabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
Cross-region snapshot copy was temporarily disabled. Try your request again.
" - }, - "CreateClusterMessage":{ - "type":"structure", - "required":[ - "ClusterIdentifier", - "NodeType", - "MasterUsername", - "MasterUserPassword" - ], - "members":{ - "DBName":{ - "shape":"String", - "documentation":"The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Example: myexamplecluster
The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node
Default: multi-node
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.
The user name associated with the master user account for the cluster that is being created.
Constraints:
The password associated with the master user account for the cluster that is being created.
Constraints:
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
" - }, - "VpcSecurityGroupIds":{ - "shape":"VpcSecurityGroupIdList", - "documentation":"A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
" - }, - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
" - }, - "ClusterParameterGroupName":{ - "shape":"String", - "documentation":"The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
" - }, - "PubliclyAccessible":{ - "shape":"BooleanOptional", - "documentation":"If true, the cluster can be accessed from a public network.
If true, the data in the cluster is encrypted at rest.
Default: false
" - }, - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
" - }, - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
" - }, - "ElasticIp":{ - "shape":"String", - "documentation":"The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
" - } - }, - "documentation":"" - }, - "CreateClusterParameterGroupMessage":{ - "type":"structure", - "required":[ - "ParameterGroupName", - "ParameterGroupFamily", - "Description" - ], - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cluster parameter group.
Constraints:
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the parameter group.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - } - }, - "documentation":"" - }, - "CreateClusterSecurityGroupMessage":{ - "type":"structure", - "required":[ - "ClusterSecurityGroupName", - "Description" - ], - "members":{ - "ClusterSecurityGroupName":{ - "shape":"String", - "documentation":"
The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Example: examplesecuritygroup
A description for the security group.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - } - }, - "documentation":"???
" - }, - "CreateClusterSnapshotMessage":{ - "type":"structure", - "required":[ - "SnapshotIdentifier", - "ClusterIdentifier" - ], - "members":{ - "SnapshotIdentifier":{ - "shape":"String", - "documentation":"A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Example: my-snapshot-id
The cluster identifier for which you want a snapshot.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - } - }, - "documentation":"" - }, - "CreateClusterSubnetGroupMessage":{ - "type":"structure", - "required":[ - "ClusterSubnetGroupName", - "Description", - "SubnetIds" - ], - "members":{ - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"
The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Example: examplesubnetgroup
A description for the subnet group.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - } - }, - "documentation":"" - }, - "CreateEventSubscriptionMessage":{ - "type":"structure", - "required":[ - "SubscriptionName", - "SnsTopicArn" - ], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the event subscription to be created.
Constraints:
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
" - }, - "SourceIds":{ - "shape":"SourceIdsList", - "documentation":"A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
" - }, - "Severity":{ - "shape":"String", - "documentation":"Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
" - }, - "Enabled":{ - "shape":"BooleanOptional", - "documentation":" A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
A list of tag instances.
" - } - }, - "documentation":"" - }, - "CreateHsmClientCertificateMessage":{ - "type":"structure", - "required":["HsmClientCertificateIdentifier"], - "members":{ - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - } - }, - "documentation":"" - }, - "CreateHsmConfigurationMessage":{ - "type":"structure", - "required":[ - "HsmConfigurationIdentifier", - "Description", - "HsmIpAddress", - "HsmPartitionName", - "HsmPartitionPassword", - "HsmServerPublicCertificate" - ], - "members":{ - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"The identifier to be assigned to the new Amazon Redshift HSM configuration.
" - }, - "Description":{ - "shape":"String", - "documentation":"A text description of the HSM configuration to be created.
" - }, - "HsmIpAddress":{ - "shape":"String", - "documentation":"The IP address that the Amazon Redshift cluster must use to access the HSM.
" - }, - "HsmPartitionName":{ - "shape":"String", - "documentation":"The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
" - }, - "HsmPartitionPassword":{ - "shape":"String", - "documentation":"The password required to access the HSM partition.
" - }, - "HsmServerPublicCertificate":{ - "shape":"String", - "documentation":"The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A list of tag instances.
" - } - }, - "documentation":"" - }, - "CreateTagsMessage":{ - "type":"structure", - "required":[ - "ResourceName", - "Tags" - ], - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":" The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter tag-key and the corresponding value is passed in with the parameter tag-value. The tag-key and tag-value parameters are separated by a colon (:). Separate multiple tags with a space. For example, --tags \"tag-key\"=\"owner\":\"tag-value\"=\"admin\" \"tag-key\"=\"environment\":\"tag-value\"=\"test\" \"tag-key\"=\"version\":\"tag-value\"=\"1.0\".
Contains the output from the CreateTags action.
The name of the cluster parameter group family to which the engine default parameters apply.
" - }, - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The list of cluster default parameters.
" - } - }, - "wrapper":true, - "documentation":"Describes the default cluster parameters for a parameter group family.
" - }, - "DeleteClusterMessage":{ - "type":"structure", - "required":["ClusterIdentifier"], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster to be deleted.
Constraints:
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.
false.Default: false
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
" - }, - "DeleteClusterParameterGroupMessage":{ - "type":"structure", - "required":["ParameterGroupName"], - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"
The name of the parameter group to be deleted.
Constraints:
" - }, - "DeleteClusterSecurityGroupMessage":{ - "type":"structure", - "required":["ClusterSecurityGroupName"], - "members":{ - "ClusterSecurityGroupName":{ - "shape":"String", - "documentation":"
The name of the cluster security group to be deleted.
" - } - }, - "documentation":"" - }, - "DeleteClusterSnapshotMessage":{ - "type":"structure", - "required":["SnapshotIdentifier"], - "members":{ - "SnapshotIdentifier":{ - "shape":"String", - "documentation":"
The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available state.
The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
" - } - }, - "documentation":"" - }, - "DeleteClusterSubnetGroupMessage":{ - "type":"structure", - "required":["ClusterSubnetGroupName"], - "members":{ - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the cluster subnet group name to be deleted.
" - } - } - }, - "DeleteEventSubscriptionMessage":{ - "type":"structure", - "required":["SubscriptionName"], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"The name of the Amazon Redshift event notification subscription to be deleted.
" - } - }, - "documentation":"" - }, - "DeleteHsmClientCertificateMessage":{ - "type":"structure", - "required":["HsmClientCertificateIdentifier"], - "members":{ - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"The identifier of the HSM client certificate to be deleted.
" - } - }, - "documentation":"" - }, - "DeleteHsmConfigurationMessage":{ - "type":"structure", - "required":["HsmConfigurationIdentifier"], - "members":{ - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"The identifier of the Amazon Redshift HSM configuration to be deleted.
" - } - }, - "documentation":"" - }, - "DeleteTagsMessage":{ - "type":"structure", - "required":[ - "ResourceName", - "TagKeys" - ], - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":" The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The tag key that you want to delete.
" - } - }, - "documentation":" Contains the output from the DeleteTags action.
The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
" - }, - "DescribeClusterParametersMessage":{ - "type":"structure", - "required":["ParameterGroupName"], - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"
The name of a cluster parameter group for which to return details.
" - }, - "Source":{ - "shape":"String", - "documentation":" The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.
???
" - }, - "DescribeClusterSnapshotsMessage":{ - "type":"structure", - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster for which information about snapshots is requested.
" - }, - "SnapshotIdentifier":{ - "shape":"String", - "documentation":"The snapshot identifier of the snapshot about which to return information.
" - }, - "SnapshotType":{ - "shape":"String", - "documentation":"The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.
" - }, - "DescribeClusterSubnetGroupsMessage":{ - "type":"structure", - "members":{ - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the cluster subnet group for which information is requested.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.
" - }, - "DescribeClusterVersionsMessage":{ - "type":"structure", - "members":{ - "ClusterVersion":{ - "shape":"String", - "documentation":"
The specific cluster version to return.
Example: 1.0
The name of a specific cluster parameter group family to return details for.
Constraints:
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
" - }, - "DescribeDefaultClusterParametersMessage":{ - "type":"structure", - "required":["ParameterGroupFamily"], - "members":{ - "ParameterGroupFamily":{ - "shape":"String", - "documentation":"
The name of the cluster parameter group family.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
" - }, - "DescribeEventCategoriesMessage":{ - "type":"structure", - "members":{ - "SourceType":{ - "shape":"String", - "documentation":"
The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, snapshot, parameter group, and security group.
" - } - }, - "documentation":"" - }, - "DescribeEventSubscriptionsMessage":{ - "type":"structure", - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the Amazon Redshift event notification subscription to be described.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster.cluster-security-group.cluster-parameter-group.cluster-snapshot.The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
cluster when SourceIdentifier is a cluster identifier.cluster-security-group when SourceIdentifier is a cluster security group name.cluster-parameter-group when SourceIdentifier is a cluster parameter group name.cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
" - }, - "DescribeHsmClientCertificatesMessage":{ - "type":"structure", - "members":{ - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.
The identifier of the cluster to get the logging status from.
Example: examplecluster
" - }, - "DescribeOrderableClusterOptionsMessage":{ - "type":"structure", - "members":{ - "ClusterVersion":{ - "shape":"String", - "documentation":"
The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
" - }, - "NodeType":{ - "shape":"String", - "documentation":"The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
" - }, - "DescribeReservedNodeOfferingsMessage":{ - "type":"structure", - "members":{ - "ReservedNodeOfferingId":{ - "shape":"String", - "documentation":"
The unique identifier for the offering.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
to be provided.
" - }, - "DescribeReservedNodesMessage":{ - "type":"structure", - "members":{ - "ReservedNodeId":{ - "shape":"String", - "documentation":"Identifier for the node reservation.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
" - }, - "Marker":{ - "shape":"String", - "documentation":" An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
" - }, - "DescribeResizeMessage":{ - "type":"structure", - "required":["ClusterIdentifier"], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"
The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
" - } - }, - "documentation":"" - }, - "DescribeTagsMessage":{ - "type":"structure", - "members":{ - "ResourceName":{ - "shape":"String", - "documentation":"
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The type of resource with which you want to view tags. Valid resource types are:
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
" - }, - "MaxRecords":{ - "shape":"IntegerOptional", - "documentation":" The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
Contains the output from the DescribeTags action.
The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
" - }, - "DisableSnapshotCopyMessage":{ - "type":"structure", - "required":["ClusterIdentifier"], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
" - } - }, - "documentation":"" - }, - "Double":{"type":"double"}, - "DoubleOptional":{"type":"double"}, - "EC2SecurityGroup":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"
The status of the EC2 security group.
" - }, - "EC2SecurityGroupName":{ - "shape":"String", - "documentation":"The name of the EC2 Security Group.
" - }, - "EC2SecurityGroupOwnerId":{ - "shape":"String", - "documentation":" The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
The list of tags for the EC2 security group.
" - } - }, - "documentation":"Describes an Amazon EC2 security group.
" - }, - "EC2SecurityGroupList":{ - "type":"list", - "member":{ - "shape":"EC2SecurityGroup", - "locationName":"EC2SecurityGroup" - } - }, - "ElasticIpStatus":{ - "type":"structure", - "members":{ - "ElasticIp":{ - "shape":"String", - "documentation":"The elastic IP (EIP) address for the cluster.
" - }, - "Status":{ - "shape":"String", - "documentation":"Describes the status of the elastic IP (EIP) address.
" - } - }, - "documentation":"Describes the status of the elastic IP (EIP) address.
" - }, - "EnableLoggingMessage":{ - "type":"structure", - "required":[ - "ClusterIdentifier", - "BucketName" - ], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster on which logging is to be started.
Example: examplecluster
The name of an existing S3 bucket where the log files are to be stored.
Constraints:
The prefix applied to the log file names.
Constraints:
" - }, - "EnableSnapshotCopyMessage":{ - "type":"structure", - "required":[ - "ClusterIdentifier", - "DestinationRegion" - ], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
" - }, - "DestinationRegion":{ - "shape":"String", - "documentation":"The destination region that you want to copy snapshots to.
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
" - }, - "RetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
" - } - }, - "documentation":"" - }, - "Endpoint":{ - "type":"structure", - "members":{ - "Address":{ - "shape":"String", - "documentation":"
The DNS address of the Cluster.
" - }, - "Port":{ - "shape":"Integer", - "documentation":"The port that the database engine is listening on.
" - } - }, - "documentation":"Describes a connection endpoint.
" - }, - "Event":{ - "type":"structure", - "members":{ - "SourceIdentifier":{ - "shape":"String", - "documentation":"The identifier for the source of the event.
" - }, - "SourceType":{ - "shape":"SourceType", - "documentation":"The source type for this event.
" - }, - "Message":{ - "shape":"String", - "documentation":"The text of this event.
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"A list of the event categories.
" - }, - "Severity":{ - "shape":"String", - "documentation":"The severity of the event.
Values: ERROR, INFO
" - }, - "Date":{ - "shape":"TStamp", - "documentation":"The date and time of the event.
" - }, - "EventId":{ - "shape":"String", - "documentation":"The identifier of the event.
" - } - }, - "documentation":"Describes an event.
" - }, - "EventCategoriesList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"EventCategory" - } - }, - "EventCategoriesMap":{ - "type":"structure", - "members":{ - "SourceType":{ - "shape":"String", - "documentation":"The Amazon Redshift source type, such as cluster or cluster-snapshot, that the returned categories belong to.
" - }, - "Events":{ - "shape":"EventInfoMapList", - "documentation":"The events in the event category.
" - } - }, - "wrapper":true - }, - "EventCategoriesMapList":{ - "type":"list", - "member":{ - "shape":"EventCategoriesMap", - "locationName":"EventCategoriesMap" - } - }, - "EventCategoriesMessage":{ - "type":"structure", - "members":{ - "EventCategoriesMapList":{ - "shape":"EventCategoriesMapList", - "documentation":"A list of event categories descriptions.
" - } - }, - "documentation":"" - }, - "EventInfoMap":{ - "type":"structure", - "members":{ - "EventId":{ - "shape":"String", - "documentation":"
The identifier of an Amazon Redshift event.
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"The category of an Amazon Redshift event.
" - }, - "EventDescription":{ - "shape":"String", - "documentation":"The description of an Amazon Redshift event.
" - }, - "Severity":{ - "shape":"String", - "documentation":"The severity of the event.
Values: ERROR, INFO
" - } - }, - "wrapper":true - }, - "EventInfoMapList":{ - "type":"list", - "member":{ - "shape":"EventInfoMap", - "locationName":"EventInfoMap" - } - }, - "EventList":{ - "type":"list", - "member":{ - "shape":"Event", - "locationName":"Event" - } - }, - "EventSubscription":{ - "type":"structure", - "members":{ - "CustomerAwsId":{ - "shape":"String", - "documentation":"The AWS customer account associated with the Amazon Redshift event notification subscription.
" - }, - "CustSubscriptionId":{ - "shape":"String", - "documentation":"The name of the Amazon Redshift event notification subscription.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
" - }, - "Status":{ - "shape":"String", - "documentation":"The status of the Amazon Redshift event notification subscription.
Constraints:
The date and time the Amazon Redshift event notification subscription was created.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.
" - }, - "SourceIdsList":{ - "shape":"SourceIdsList", - "documentation":"A list of the sources that publish events to the Amazon Redshift event notification subscription.
" - }, - "EventCategoriesList":{ - "shape":"EventCategoriesList", - "documentation":"The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security
" - }, - "Severity":{ - "shape":"String", - "documentation":"The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
" - }, - "Enabled":{ - "shape":"Boolean", - "documentation":"A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.
The list of tags for the event subscription.
" - } - }, - "wrapper":true - }, - "EventSubscriptionQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"EventSubscriptionQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "EventSubscriptionsList":{ - "type":"list", - "member":{ - "shape":"EventSubscription", - "locationName":"EventSubscription" - } - }, - "EventSubscriptionsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of event subscriptions.
" - } - }, - "documentation":"" - }, - "EventsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of Event instances.
" - } - }, - "documentation":"Contains the output from the DescribeEvents action.
" - }, - "HsmClientCertificate":{ - "type":"structure", - "members":{ - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"The identifier of the HSM client certificate.
" - }, - "HsmClientCertificatePublicKey":{ - "shape":"String", - "documentation":"The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the HSM client certificate.
" - } - }, - "wrapper":true, - "documentation":"Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
" - }, - "HsmClientCertificateAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"HsmClientCertificateAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
" - }, - "HsmClientCertificateList":{ - "type":"list", - "member":{ - "shape":"HsmClientCertificate", - "locationName":"HsmClientCertificate" - } - }, - "HsmClientCertificateMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
" - } - }, - "documentation":"" - }, - "HsmClientCertificateNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"HsmClientCertificateNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM client certificate with the specified identifier.
" - }, - "HsmClientCertificateQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"HsmClientCertificateQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "HsmConfiguration":{ - "type":"structure", - "members":{ - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"The name of the Amazon Redshift HSM configuration.
" - }, - "Description":{ - "shape":"String", - "documentation":"A text description of the HSM configuration.
" - }, - "HsmIpAddress":{ - "shape":"String", - "documentation":"The IP address that the Amazon Redshift cluster must use to access the HSM.
" - }, - "HsmPartitionName":{ - "shape":"String", - "documentation":"The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the HSM configuration.
" - } - }, - "wrapper":true, - "documentation":"Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
" - }, - "HsmConfigurationAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"HsmConfigurationAlreadyExistsFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is already an existing Amazon Redshift HSM configuration with the specified identifier.
" - }, - "HsmConfigurationList":{ - "type":"list", - "member":{ - "shape":"HsmConfiguration", - "locationName":"HsmConfiguration" - } - }, - "HsmConfigurationMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of Amazon Redshift HSM configurations.
" - } - }, - "documentation":"" - }, - "HsmConfigurationNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"HsmConfigurationNotFoundFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is no Amazon Redshift HSM configuration with the specified identifier.
" - }, - "HsmConfigurationQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"HsmConfigurationQuotaExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "HsmStatus":{ - "type":"structure", - "members":{ - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
" - }, - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
" - }, - "Status":{ - "shape":"String", - "documentation":"Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
" - } - }, - "documentation":"" - }, - "IPRange":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"The status of the IP range, for example, \"authorized\".
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":"The IP range in Classless Inter-Domain Routing (CIDR) notation.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the IP range.
" - } - }, - "documentation":"Describes an IP range used in a security group.
" - }, - "IPRangeList":{ - "type":"list", - "member":{ - "shape":"IPRange", - "locationName":"IPRange" - } - }, - "ImportTablesCompleted":{ - "type":"list", - "member":{"shape":"String"} - }, - "ImportTablesInProgress":{ - "type":"list", - "member":{"shape":"String"} - }, - "ImportTablesNotStarted":{ - "type":"list", - "member":{"shape":"String"} - }, - "IncompatibleOrderableOptions":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"IncompatibleOrderableOptions", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified options are incompatible.
" - }, - "InsufficientClusterCapacityFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientClusterCapacity", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The number of nodes specified exceeds the allotted capacity of the cluster.
" - }, - "InsufficientS3BucketPolicyFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InsufficientS3BucketPolicyFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
" - }, - "Integer":{"type":"integer"}, - "IntegerOptional":{"type":"integer"}, - "InvalidClusterParameterGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidClusterParameterGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
" - }, - "InvalidClusterSecurityGroupStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidClusterSecurityGroupState", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The state of the cluster security group is not available.
The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.
The specified cluster is not in the available state.
The cluster subnet group cannot be deleted because it is in use.
" - }, - "InvalidClusterSubnetStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidClusterSubnetStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The state of the subnet is invalid.
" - }, - "InvalidElasticIpFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidElasticIpFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Elastic IP (EIP) is invalid or cannot be found.
" - }, - "InvalidHsmClientCertificateStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidHsmClientCertificateStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
The restore is invalid.
" - }, - "InvalidS3BucketNameFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidS3BucketNameFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
" - }, - "InvalidS3KeyPrefixFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidS3KeyPrefixFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The string specified for the logging S3 key prefix does not comply with the documented constraints.
" - }, - "InvalidSubnet":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSubnet", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The requested subnet is not valid, or not all of the subnets are in the same VPC.
" - }, - "InvalidSubscriptionStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidSubscriptionStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
" - }, - "InvalidTagFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidTagFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The tag is invalid.
" - }, - "InvalidVPCNetworkStateFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"InvalidVPCNetworkStateFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster subnet group does not cover all Availability Zones.
" - }, - "LoggingStatus":{ - "type":"structure", - "members":{ - "LoggingEnabled":{ - "shape":"Boolean", - "documentation":"true if logging is on, false if logging is off.
The name of the S3 bucket where the log files are stored.
" - }, - "S3KeyPrefix":{ - "shape":"String", - "documentation":"The prefix applied to the log file names.
" - }, - "LastSuccessfulDeliveryTime":{ - "shape":"TStamp", - "documentation":"The last time when logs were delivered.
" - }, - "LastFailureTime":{ - "shape":"TStamp", - "documentation":"The last time when logs failed to be delivered.
" - }, - "LastFailureMessage":{ - "shape":"String", - "documentation":"The message indicating that logs failed to be delivered.
" - } - }, - "documentation":"Describes the status of logging for a cluster.
" - }, - "Long":{"type":"long"}, - "LongOptional":{"type":"long"}, - "ModifyClusterMessage":{ - "type":"structure", - "required":["ClusterIdentifier"], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The unique identifier of the cluster to be modified.
Example: examplecluster
The new cluster type.
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.
The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than 0.
A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
" - }, - "MasterUserPassword":{ - "shape":"String", - "documentation":" The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting.
Constraints:
The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
" - }, - "AutomatedSnapshotRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
" - }, - "ClusterVersion":{ - "shape":"String", - "documentation":"The new version number of the Amazon Redshift engine to upgrade to.
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
Default: false
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
" - }, - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
" - }, - "NewClusterIdentifier":{ - "shape":"String", - "documentation":"The new identifier for the cluster.
Constraints:
Example: examplecluster
The name of the parameter group to be modified.
" - }, - "Parameters":{ - "shape":"ParametersList", - "documentation":"An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
" - } - }, - "documentation":"" - }, - "ModifyClusterSubnetGroupMessage":{ - "type":"structure", - "required":[ - "ClusterSubnetGroupName", - "SubnetIds" - ], - "members":{ - "ClusterSubnetGroupName":{ - "shape":"String", - "documentation":"
The name of the subnet group to be modified.
" - }, - "Description":{ - "shape":"String", - "documentation":"A text description of the subnet group to be modified.
" - }, - "SubnetIds":{ - "shape":"SubnetIdentifierList", - "documentation":"An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
" - } - }, - "documentation":"" - }, - "ModifyEventSubscriptionMessage":{ - "type":"structure", - "required":["SubscriptionName"], - "members":{ - "SubscriptionName":{ - "shape":"String", - "documentation":"
The name of the modified Amazon Redshift event notification subscription.
" - }, - "SnsTopicArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
" - }, - "SourceType":{ - "shape":"String", - "documentation":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
" - }, - "SourceIds":{ - "shape":"SourceIdsList", - "documentation":"A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
" - }, - "EventCategories":{ - "shape":"EventCategoriesList", - "documentation":"Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
" - }, - "Severity":{ - "shape":"String", - "documentation":"Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
" - }, - "Enabled":{ - "shape":"BooleanOptional", - "documentation":" A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
" - }, - "RetentionPeriod":{ - "shape":"Integer", - "documentation":"The number of days to retain automated snapshots in the destination region after they are copied from the source region.
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
" - } - }, - "documentation":"" - }, - "NumberOfNodesPerClusterLimitExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"NumberOfNodesPerClusterLimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The operation would exceed the number of nodes allowed for a cluster.
" - }, - "NumberOfNodesQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"NumberOfNodesQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "OrderableClusterOption":{ - "type":"structure", - "members":{ - "ClusterVersion":{ - "shape":"String", - "documentation":"The version of the orderable cluster.
" - }, - "ClusterType":{ - "shape":"String", - "documentation":" The cluster type, for example multi-node.
The node type for the orderable cluster.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZoneList", - "documentation":"A list of availability zones for the orderable cluster.
" - } - }, - "wrapper":true, - "documentation":"Describes an orderable cluster option.
" - }, - "OrderableClusterOptionsList":{ - "type":"list", - "member":{ - "shape":"OrderableClusterOption", - "locationName":"OrderableClusterOption" - } - }, - "OrderableClusterOptionsMessage":{ - "type":"structure", - "members":{ - "OrderableClusterOptions":{ - "shape":"OrderableClusterOptionsList", - "documentation":"An OrderableClusterOption structure containing information about orderable options for the Cluster.
" - }, - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Contains the output from the DescribeOrderableClusterOptions action.
" - }, - "Parameter":{ - "type":"structure", - "members":{ - "ParameterName":{ - "shape":"String", - "documentation":"The name of the parameter.
" - }, - "ParameterValue":{ - "shape":"String", - "documentation":"The value of the parameter.
" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the parameter.
" - }, - "Source":{ - "shape":"String", - "documentation":"The source of the parameter value, such as \"engine-default\" or \"user\".
" - }, - "DataType":{ - "shape":"String", - "documentation":"The data type of the parameter.
" - }, - "AllowedValues":{ - "shape":"String", - "documentation":"The valid range of values for the parameter.
" - }, - "IsModifiable":{ - "shape":"Boolean", - "documentation":" If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
" - } - }, - "documentation":"Describes a parameter in a cluster parameter group.
" - }, - "ParameterGroupList":{ - "type":"list", - "member":{ - "shape":"ClusterParameterGroup", - "locationName":"ClusterParameterGroup" - } - }, - "ParametersList":{ - "type":"list", - "member":{ - "shape":"Parameter", - "locationName":"Parameter" - } - }, - "PendingModifiedValues":{ - "type":"structure", - "members":{ - "MasterUserPassword":{ - "shape":"String", - "documentation":"The pending or in-progress change of the master user password for the cluster.
" - }, - "NodeType":{ - "shape":"String", - "documentation":"The pending or in-progress change of the cluster's node type.
" - }, - "NumberOfNodes":{ - "shape":"IntegerOptional", - "documentation":"The pending or in-progress change of the number of nodes in the cluster.
" - }, - "ClusterType":{ - "shape":"String", - "documentation":"The pending or in-progress change of the cluster type.
" - }, - "ClusterVersion":{ - "shape":"String", - "documentation":"The pending or in-progress change of the service version.
" - }, - "AutomatedSnapshotRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"The pending or in-progress change of the automated snapshot retention period.
" - }, - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The pending or in-progress change of the new identifier for the cluster.
" - } - }, - "documentation":"Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.
" - }, - "PurchaseReservedNodeOfferingMessage":{ - "type":"structure", - "required":["ReservedNodeOfferingId"], - "members":{ - "ReservedNodeOfferingId":{ - "shape":"String", - "documentation":"The unique identifier of the reserved node offering you want to purchase.
" - }, - "NodeCount":{ - "shape":"IntegerOptional", - "documentation":"The number of reserved nodes you want to purchase.
Default: 1
The cluster identifier.
" - } - }, - "documentation":"" - }, - "RecurringCharge":{ - "type":"structure", - "members":{ - "RecurringChargeAmount":{ - "shape":"Double", - "documentation":"
The amount charged per the period of time specified by the recurring charge frequency.
" - }, - "RecurringChargeFrequency":{ - "shape":"String", - "documentation":"The frequency at which the recurring charge amount is applied.
" - } - }, - "wrapper":true, - "documentation":"Describes a recurring charge.
" - }, - "RecurringChargeList":{ - "type":"list", - "member":{ - "shape":"RecurringCharge", - "locationName":"RecurringCharge" - } - }, - "ReservedNode":{ - "type":"structure", - "members":{ - "ReservedNodeId":{ - "shape":"String", - "documentation":"The unique identifier for the reservation.
" - }, - "ReservedNodeOfferingId":{ - "shape":"String", - "documentation":"The identifier for the reserved node offering.
" - }, - "NodeType":{ - "shape":"String", - "documentation":"The node type of the reserved node.
" - }, - "StartTime":{ - "shape":"TStamp", - "documentation":"The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration of the node reservation in seconds.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The fixed cost Amazon Redshift charged you for this reserved node.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The hourly rate Amazon Redshift charge you for this reserved node.
" - }, - "CurrencyCode":{ - "shape":"String", - "documentation":"The currency code for the reserved cluster.
" - }, - "NodeCount":{ - "shape":"Integer", - "documentation":"The number of reserved compute nodes.
" - }, - "State":{ - "shape":"String", - "documentation":"The state of the reserved compute node.
Possible Values:
The anticipated utilization of the reserved node, as defined in the reserved node offering.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The recurring charges for the reserved node.
" - } - }, - "wrapper":true, - "documentation":"Describes a reserved node.
" - }, - "ReservedNodeAlreadyExistsFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedNodeAlreadyExists", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"User already has a reservation with the given identifier.
" - }, - "ReservedNodeList":{ - "type":"list", - "member":{ - "shape":"ReservedNode", - "locationName":"ReservedNode" - } - }, - "ReservedNodeNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedNodeNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified reserved compute node not found.
" - }, - "ReservedNodeOffering":{ - "type":"structure", - "members":{ - "ReservedNodeOfferingId":{ - "shape":"String", - "documentation":"The offering identifier.
" - }, - "NodeType":{ - "shape":"String", - "documentation":"The node type offered by the reserved node offering.
" - }, - "Duration":{ - "shape":"Integer", - "documentation":"The duration, in seconds, for which the offering will reserve the node.
" - }, - "FixedPrice":{ - "shape":"Double", - "documentation":"The upfront fixed charge you will pay to purchase the specific reserved node offering.
" - }, - "UsagePrice":{ - "shape":"Double", - "documentation":"The rate you are charged for each hour the cluster that is using the offering is running.
" - }, - "CurrencyCode":{ - "shape":"String", - "documentation":"The currency code for the compute nodes offering.
" - }, - "OfferingType":{ - "shape":"String", - "documentation":"The anticipated utilization of the reserved node, as defined in the reserved node offering.
" - }, - "RecurringCharges":{ - "shape":"RecurringChargeList", - "documentation":"The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
" - } - }, - "wrapper":true, - "documentation":"Describes a reserved node offering.
" - }, - "ReservedNodeOfferingList":{ - "type":"list", - "member":{ - "shape":"ReservedNodeOffering", - "locationName":"ReservedNodeOffering" - } - }, - "ReservedNodeOfferingNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedNodeOfferingNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Specified offering does not exist.
" - }, - "ReservedNodeOfferingsMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of reserved node offerings.
" - } - }, - "documentation":"Contains the output from the DescribeReservedNodeOfferings action.
" - }, - "ReservedNodeQuotaExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ReservedNodeQuotaExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
" - }, - "ReservedNodesMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The list of reserved nodes.
" - } - }, - "documentation":"Contains the output from the DescribeReservedNodes action.
" - }, - "ResetClusterParameterGroupMessage":{ - "type":"structure", - "required":["ParameterGroupName"], - "members":{ - "ParameterGroupName":{ - "shape":"String", - "documentation":"The name of the cluster parameter group to be reset.
" - }, - "ResetAllParameters":{ - "shape":"Boolean", - "documentation":" If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.
Constraints: A maximum of 20 parameters can be reset in a single request.
" - } - }, - "documentation":"" - }, - "ResizeNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ResizeNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"
A resize operation for the specified cluster is not found.
" - }, - "ResizeProgressMessage":{ - "type":"structure", - "members":{ - "TargetNodeType":{ - "shape":"String", - "documentation":"The node type that the cluster will have after the resize operation is complete.
" - }, - "TargetNumberOfNodes":{ - "shape":"IntegerOptional", - "documentation":"The number of nodes that the cluster will have after the resize operation is complete.
" - }, - "TargetClusterType":{ - "shape":"String", - "documentation":"The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED
The names of tables that have been completely imported .
Valid Values: List of table names.
" - }, - "ImportTablesInProgress":{ - "shape":"ImportTablesInProgress", - "documentation":"The names of tables that are being currently imported.
Valid Values: List of table names.
" - }, - "ImportTablesNotStarted":{ - "shape":"ImportTablesNotStarted", - "documentation":"The names of tables that have not been yet imported.
Valid Values: List of table names
" - }, - "AvgResizeRateInMegaBytesPerSecond":{ - "shape":"DoubleOptional", - "documentation":"The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
" - }, - "TotalResizeDataInMegaBytes":{ - "shape":"LongOptional", - "documentation":"The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
" - }, - "ProgressInMegaBytes":{ - "shape":"LongOptional", - "documentation":"While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
" - }, - "ElapsedTimeInSeconds":{ - "shape":"LongOptional", - "documentation":"The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
" - }, - "EstimatedTimeToCompletionInSeconds":{ - "shape":"LongOptional", - "documentation":"The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
" - } - }, - "documentation":"Describes the result of a cluster resize operation.
" - }, - "ResourceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"ResourceNotFoundFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The resource could not be found.
" - }, - "RestoreFromClusterSnapshotMessage":{ - "type":"structure", - "required":[ - "ClusterIdentifier", - "SnapshotIdentifier" - ], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
" - }, - "Port":{ - "shape":"IntegerOptional", - "documentation":"The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
Default: true
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
" - }, - "PubliclyAccessible":{ - "shape":"BooleanOptional", - "documentation":" If true, the cluster can be accessed from a public network.
The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
" - }, - "HsmClientCertificateIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
" - }, - "HsmConfigurationIdentifier":{ - "shape":"String", - "documentation":"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
" - }, - "ElasticIp":{ - "shape":"String", - "documentation":"The elastic IP (EIP) address for the cluster.
" - }, - "ClusterParameterGroupName":{ - "shape":"String", - "documentation":"The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
" - }, - "VpcSecurityGroupIds":{ - "shape":"VpcSecurityGroupIdList", - "documentation":"A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
" - }, - "PreferredMaintenanceWindow":{ - "shape":"String", - "documentation":"The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
" - }, - "AutomatedSnapshotRetentionPeriod":{ - "shape":"IntegerOptional", - "documentation":"The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
" - } - }, - "documentation":"" - }, - "RestoreStatus":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"String", - "documentation":"The status of the restore action. Returns starting, restoring, completed, or failed.
" - }, - "CurrentRestoreRateInMegaBytesPerSecond":{ - "shape":"Double", - "documentation":"The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
" - }, - "SnapshotSizeInMegaBytes":{ - "shape":"Long", - "documentation":"The size of the set of snapshot data used to restore the cluster.
" - }, - "ProgressInMegaBytes":{ - "shape":"Long", - "documentation":"The number of megabytes that have been transferred from snapshot storage.
" - }, - "ElapsedTimeInSeconds":{ - "shape":"Long", - "documentation":"The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
" - }, - "EstimatedTimeToCompletionInSeconds":{ - "shape":"Long", - "documentation":"The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
" - } - }, - "documentation":"Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
" - }, - "RevokeClusterSecurityGroupIngressMessage":{ - "type":"structure", - "required":["ClusterSecurityGroupName"], - "members":{ - "ClusterSecurityGroupName":{ - "shape":"String", - "documentation":"The name of the security Group from which to revoke the ingress rule.
" - }, - "CIDRIP":{ - "shape":"String", - "documentation":" The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
???
" - }, - "RevokeSnapshotAccessMessage":{ - "type":"structure", - "required":[ - "SnapshotIdentifier", - "AccountWithRestoreAccess" - ], - "members":{ - "SnapshotIdentifier":{ - "shape":"String", - "documentation":"The identifier of the snapshot that the account can no longer access.
" - }, - "SnapshotClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
" - }, - "AccountWithRestoreAccess":{ - "shape":"String", - "documentation":"The identifier of the AWS customer account that can no longer restore the specified snapshot.
" - } - }, - "documentation":"" - }, - "RotateEncryptionKeyMessage":{ - "type":"structure", - "required":["ClusterIdentifier"], - "members":{ - "ClusterIdentifier":{ - "shape":"String", - "documentation":"
The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
" - } - }, - "documentation":"" - }, - "SNSInvalidTopicFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSInvalidTopic", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
" - }, - "SNSNoAuthorizationFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSNoAuthorization", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You do not have permission to publish to the specified Amazon SNS topic.
" - }, - "SNSTopicArnNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SNSTopicArnNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
" - }, - "Snapshot":{ - "type":"structure", - "members":{ - "SnapshotIdentifier":{ - "shape":"String", - "documentation":"The snapshot identifier that is provided in the request.
" - }, - "ClusterIdentifier":{ - "shape":"String", - "documentation":"The identifier of the cluster for which the snapshot was taken.
" - }, - "SnapshotCreateTime":{ - "shape":"TStamp", - "documentation":"The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
" - }, - "Status":{ - "shape":"String", - "documentation":"The snapshot status. The value of the status depends on the API operation used.
The port that the cluster is listening on.
" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the cluster was created.
" - }, - "ClusterCreateTime":{ - "shape":"TStamp", - "documentation":"The time (UTC) when the cluster was originally created.
" - }, - "MasterUsername":{ - "shape":"String", - "documentation":"The master user name for the cluster.
" - }, - "ClusterVersion":{ - "shape":"String", - "documentation":"The version ID of the Amazon Redshift engine that is running on the cluster.
" - }, - "SnapshotType":{ - "shape":"String", - "documentation":"The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".
" - }, - "NodeType":{ - "shape":"String", - "documentation":"The node type of the nodes in the cluster.
" - }, - "NumberOfNodes":{ - "shape":"Integer", - "documentation":"The number of nodes in the cluster.
" - }, - "DBName":{ - "shape":"String", - "documentation":"The name of the database that was created when the cluster was created.
" - }, - "VpcId":{ - "shape":"String", - "documentation":"The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"If true, the data in the snapshot is encrypted at rest.
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
" - }, - "EncryptedWithHSM":{ - "shape":"Boolean", - "documentation":"A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
" - }, - "TotalBackupSizeInMegaBytes":{ - "shape":"Double", - "documentation":"The size of the complete set of backup data that would be used to restore the cluster.
" - }, - "ActualIncrementalBackupSizeInMegaBytes":{ - "shape":"Double", - "documentation":"The size of the incremental backup.
" - }, - "BackupProgressInMegaBytes":{ - "shape":"Double", - "documentation":"The number of megabytes that have been transferred to the snapshot backup.
" - }, - "CurrentBackupRateInMegaBytesPerSecond":{ - "shape":"Double", - "documentation":" The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
" - }, - "SourceRegion":{ - "shape":"String", - "documentation":"The source region from which the snapshot was copied.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The list of tags for the cluster snapshot.
" - } - }, - "wrapper":true, - "documentation":"Describes a snapshot.
" - }, - "SnapshotCopyAlreadyDisabledFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotCopyAlreadyDisabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster already has cross-region snapshot copy disabled.
" - }, - "SnapshotCopyAlreadyEnabledFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotCopyAlreadyEnabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The cluster already has cross-region snapshot copy enabled.
" - }, - "SnapshotCopyDisabledFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SnapshotCopyDisabledFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Cross-region snapshot copy was temporarily disabled. Try your request again.
" - }, - "SnapshotList":{ - "type":"list", - "member":{ - "shape":"Snapshot", - "locationName":"Snapshot" - } - }, - "SnapshotMessage":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A list of Snapshot instances.
" - } - }, - "documentation":"Contains the output from the DescribeClusterSnapshots action.
" - }, - "SourceIdsList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SourceId" - } - }, - "SourceNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified Amazon Redshift event source could not be found.
" - }, - "SourceType":{ - "type":"string", - "enum":[ - "cluster", - "cluster-parameter-group", - "cluster-security-group", - "cluster-snapshot" - ] - }, - "String":{"type":"string"}, - "Subnet":{ - "type":"structure", - "members":{ - "SubnetIdentifier":{ - "shape":"String", - "documentation":"The identifier of the subnet.
" - }, - "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, - "SubnetStatus":{ - "shape":"String", - "documentation":"The status of the subnet.
" - } - }, - "documentation":"Describes a subnet.
" - }, - "SubnetAlreadyInUse":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubnetAlreadyInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A specified subnet is already in use by another cluster.
" - }, - "SubnetIdentifierList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"SubnetIdentifier" - } - }, - "SubnetList":{ - "type":"list", - "member":{ - "shape":"Subnet", - "locationName":"Subnet" - } - }, - "SubscriptionAlreadyExistFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionAlreadyExist", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"There is already an existing event notification subscription with the specified name.
" - }, - "SubscriptionCategoryNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionCategoryNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
" - }, - "SubscriptionEventIdNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionEventIdNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event with the specified event ID does not exist.
" - }, - "SubscriptionNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"An Amazon Redshift event notification subscription with the specified name does not exist.
" - }, - "SubscriptionSeverityNotFoundFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"SubscriptionSeverityNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
" - }, - "TStamp":{"type":"timestamp"}, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"String", - "documentation":"The key, or name, for the resource tag.
" - }, - "Value":{ - "shape":"String", - "documentation":"The value for the resource tag.
" - } - }, - "documentation":"A tag consisting of a name/value pair for a resource.
" - }, - "TagKeyList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"TagKey" - } - }, - "TagLimitExceededFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"TagLimitExceededFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request exceeds the limit of 10 tags for the resource.
" - }, - "TagList":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"Tag" - } - }, - "TagValueList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"TagValue" - } - }, - "TaggedResource":{ - "type":"structure", - "members":{ - "Tag":{ - "shape":"Tag", - "documentation":"The tag for the resource.
" - }, - "ResourceName":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) with which the tag is associated. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The type of resource with which the tag is associated. Valid resource types are:
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
" - } - }, - "documentation":"A tag and its associated resource.
" - }, - "TaggedResourceList":{ - "type":"list", - "member":{ - "shape":"TaggedResource", - "locationName":"TaggedResource" - } - }, - "TaggedResourceListMessage":{ - "type":"structure", - "members":{ - "TaggedResources":{ - "shape":"TaggedResourceList", - "documentation":"A list of tags with their associated resources.
" - }, - "Marker":{ - "shape":"String", - "documentation":" A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Contains the output from the DescribeTags action.
Your account is not authorized to perform the requested operation.
" - }, - "UnknownSnapshotCopyRegionFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"UnknownSnapshotCopyRegionFault", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified region is incorrect or does not exist.
" - }, - "UnsupportedOptionFault":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"UnsupportedOptionFault", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A request option was specified that is not supported.
" - }, - "VpcSecurityGroupIdList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"VpcSecurityGroupId" - } - }, - "VpcSecurityGroupMembership":{ - "type":"structure", - "members":{ - "VpcSecurityGroupId":{"shape":"String"}, - "Status":{"shape":"String"} - }, - "documentation":"Describes the members of a VPC security group.
" - }, - "VpcSecurityGroupMembershipList":{ - "type":"list", - "member":{ - "shape":"VpcSecurityGroupMembership", - "locationName":"VpcSecurityGroup" - } - }, - "AuthorizeClusterSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} - } - }, - "AuthorizeSnapshotAccessResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "CopyClusterSnapshotResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "CreateClusterResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "CreateClusterParameterGroupResult":{ - "type":"structure", - "members":{ - "ClusterParameterGroup":{"shape":"ClusterParameterGroup"} - } - }, - "CreateClusterSecurityGroupResult":{ - "type":"structure", - "members":{ - "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} - } - }, - "CreateClusterSnapshotResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "CreateClusterSubnetGroupResult":{ - "type":"structure", - "members":{ - "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} - } - }, - "CreateEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "CreateHsmClientCertificateResult":{ - "type":"structure", - "members":{ - "HsmClientCertificate":{"shape":"HsmClientCertificate"} - } - }, - "CreateHsmConfigurationResult":{ - "type":"structure", - "members":{ - "HsmConfiguration":{"shape":"HsmConfiguration"} - } - }, - "DeleteClusterResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "DeleteClusterSnapshotResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "DescribeDefaultClusterParametersResult":{ - "type":"structure", - "members":{ - "DefaultClusterParameters":{"shape":"DefaultClusterParameters"} - } - }, - "DisableSnapshotCopyResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "EnableSnapshotCopyResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "ModifyClusterResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "ModifyClusterSubnetGroupResult":{ - "type":"structure", - "members":{ - "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} - } - }, - "ModifyEventSubscriptionResult":{ - "type":"structure", - "members":{ - "EventSubscription":{"shape":"EventSubscription"} - } - }, - "ModifySnapshotCopyRetentionPeriodResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "PurchaseReservedNodeOfferingResult":{ - "type":"structure", - "members":{ - "ReservedNode":{"shape":"ReservedNode"} - } - }, - "RebootClusterResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "RestoreFromClusterSnapshotResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - }, - "RevokeClusterSecurityGroupIngressResult":{ - "type":"structure", - "members":{ - "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} - } - }, - "RevokeSnapshotAccessResult":{ - "type":"structure", - "members":{ - "Snapshot":{"shape":"Snapshot"} - } - }, - "RotateEncryptionKeyResult":{ - "type":"structure", - "members":{ - "Cluster":{"shape":"Cluster"} - } - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.paginators.json deleted file mode 100644 index 03027de356..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.paginators.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "pagination": { - "DescribeClusterParameterGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ParameterGroups" - }, - "DescribeClusterParameters": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Parameters" - }, - "DescribeClusterSecurityGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ClusterSecurityGroups" - }, - "DescribeClusterSnapshots": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Snapshots" - }, - "DescribeClusterSubnetGroups": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ClusterSubnetGroups" - }, - "DescribeClusterVersions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ClusterVersions" - }, - "DescribeClusters": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Clusters" - }, - "DescribeDefaultClusterParameters": { - "input_token": "Marker", - "output_token": "DefaultClusterParameters.Marker", - "limit_key": "MaxRecords", - "result_key": "DefaultClusterParameters.Parameters" - }, - "DescribeEventSubscriptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "EventSubscriptionsList" - }, - "DescribeEvents": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "Events" - }, - "DescribeHsmClientCertificates": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "HsmClientCertificates" - }, - "DescribeHsmConfigurations": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "HsmConfigurations" - }, - "DescribeOrderableClusterOptions": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "OrderableClusterOptions" - }, - "DescribeReservedNodeOfferings": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedNodeOfferings" - }, - "DescribeReservedNodes": { - "input_token": "Marker", - "output_token": "Marker", - "limit_key": "MaxRecords", - "result_key": "ReservedNodes" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.waiters.json deleted file mode 100644 index d91b0eb334..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/redshift/2012-12-01.waiters.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "version": 2, - "waiters": { - "ClusterAvailable": { - "delay": 60, - "operation": "DescribeClusters", - "maxAttempts": 30, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Clusters[].ClusterStatus" - }, - { - "expected": "deleting", - "matcher": "pathAny", - "state": "failure", - "argument": "Clusters[].ClusterStatus" - }, - { - "expected": "ClusterNotFound", - "matcher": "error", - "state": "retry" - } - ] - }, - "ClusterDeleted": { - "delay": 60, - "operation": "DescribeClusters", - "maxAttempts": 30, - "acceptors": [ - { - "expected": "ClusterNotFound", - "matcher": "error", - "state": "success" - }, - { - "expected": "creating", - "matcher": "pathAny", - "state": "failure", - "argument": "Clusters[].ClusterStatus" - }, - { - "expected": "rebooting", - "matcher": "pathAny", - "state": "failure", - "argument": "Clusters[].ClusterStatus" - } - ] - }, - "SnapshotAvailable": { - "delay": 15, - "operation": "DescribeClusterSnapshots", - "maxAttempts": 20, - "acceptors": [ - { - "expected": "available", - "matcher": "pathAll", - "state": "success", - "argument": "Snapshots[].Status" - }, - { - "expected": "failed", - "matcher": "pathAny", - "state": "failure", - "argument": "Snapshots[].Status" - }, - { - "expected": "deleted", - "matcher": "pathAny", - "state": "failure", - "argument": "Snapshots[].Status" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/route53/2013-04-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/route53/2013-04-01.normal.json deleted file mode 100644 index 3baa20c0d9..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/route53/2013-04-01.normal.json +++ /dev/null @@ -1,3073 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2013-04-01", - "endpointPrefix":"route53", - "globalEndpoint":"route53.amazonaws.com", - "serviceAbbreviation":"Route 53", - "serviceFullName":"Amazon Route 53", - "signatureVersion":"v3https", - "protocol":"rest-xml" - }, - "operations":{ - "AssociateVPCWithHostedZone":{ - "name":"AssociateVPCWithHostedZone", - "http":{ - "method":"POST", - "requestUri":"/2013-04-01/hostedzone/{Id}/associatevpc" - }, - "input":{ - "shape":"AssociateVPCWithHostedZoneRequest", - "documentation":"A complex type that contains information about the request to associate a VPC with an hosted zone.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"AssociateVPCWithHostedZoneRequest" - }, - "output":{ - "shape":"AssociateVPCWithHostedZoneResponse", - "documentation":"A complex type containing the response information for the request.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"InvalidVPCId", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone you are trying to create for your VPC_ID does not belong to you. Route 53 returns this error when the VPC specified by VPCId does not belong to you.
Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"PublicZoneVPCAssociation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone you are trying to associate VPC with doesn't have any VPC association. Route 53 currently doesn't support associate a VPC with a public hosted zone.
" - }, - { - "shape":"ConflictingDomainExists", - "exception":true - } - ], - "documentation":"This action associates a VPC with an hosted zone.
To associate a VPC with an hosted zone, send a POST request to the 2013-04-01/hostedzone/hosted zone ID/associatevpc resource. The request body must include an XML document with a AssociateVPCWithHostedZoneRequest element. The response returns the AssociateVPCWithHostedZoneResponse element that contains ChangeInfo for you to track the progress of the AssociateVPCWithHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.
A complex type that contains a change batch.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"ChangeResourceRecordSetsRequest" - }, - "output":{ - "shape":"ChangeResourceRecordSetsResponse", - "documentation":"A complex type containing the response for the request.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"InvalidChangeBatch", - "exception":true, - "documentation":"This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"PriorRequestNotComplete", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request was rejected because Route 53 was still processing a prior request.
" - } - ], - "documentation":"Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the 2013-04-01/hostedzone/hosted Zone ID/rrset resource. The request body must include an XML document with a ChangeResourceRecordSetsRequest element.
Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide.
InvalidChangeBatch error.In response to a ChangeResourceRecordSets request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is PENDING. This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC.
Note the following limitations on a ChangeResourceRecordSets request:
- A request cannot contain more than 100 Change elements.
- A request cannot contain more than 1000 ResourceRecord elements.
The sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.
A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"ChangeTagsForResourceRequest" - }, - "output":{ - "shape":"ChangeTagsForResourceResponse", - "documentation":"Empty response for the request.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"PriorRequestNotComplete", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request was rejected because Route 53 was still processing a prior request.
" - }, - { - "shape":"ThrottlingException", - "error":{"httpStatusCode":400}, - "exception":true - } - ] - }, - "CreateHealthCheck":{ - "name":"CreateHealthCheck", - "http":{ - "method":"POST", - "requestUri":"/2013-04-01/healthcheck", - "responseCode":201 - }, - "input":{ - "shape":"CreateHealthCheckRequest", - "documentation":">A complex type that contains information about the request to create a health check.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"CreateHealthCheckRequest" - }, - "output":{ - "shape":"CreateHealthCheckResponse", - "documentation":"A complex type containing the response information for the new health check.
" - }, - "errors":[ - { - "shape":"TooManyHealthChecks", - "exception":true - }, - { - "shape":"HealthCheckAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The health check you are trying to create already exists. Route 53 returns this error when a health check has already been created with the specified CallerReference.
Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"This action creates a new health check.
To create a new health check, send a POST request to the 2013-04-01/healthcheck resource. The request body must include an XML document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.
A complex type that contains information about the request to create a hosted zone.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"CreateHostedZoneRequest" - }, - "output":{ - "shape":"CreateHostedZoneResponse", - "documentation":"A complex type containing the response information for the new hosted zone.
" - }, - "errors":[ - { - "shape":"InvalidDomainName", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This error indicates that the specified domain name is not valid.
" - }, - { - "shape":"HostedZoneAlreadyExists", - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The hosted zone you are trying to create already exists. Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.
This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
" - }, - { - "shape":"InvalidVPCId", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone you are trying to create for your VPC_ID does not belong to you. Route 53 returns this error when the VPC specified by VPCId does not belong to you.
Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"DelegationSetNotAvailable", - "exception":true, - "documentation":"Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
" - }, - { - "shape":"ConflictingDomainExists", - "exception":true - }, - { - "shape":"NoSuchDelegationSet", - "exception":true, - "documentation":"The specified delegation set does not exist.
" - }, - { - "shape":"DelegationSetNotReusable", - "exception":true, - "documentation":"The specified delegation set has not been marked as reusable.
" - } - ], - "documentation":"This action creates a new hosted zone.
To create a new hosted zone, send a POST request to the 2013-04-01/hostedzone resource. The request body must include an XML document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.
Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
When you create a zone, its initial status is PENDING. This means that it is not yet available on all DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on all Route 53 DNS servers.
When trying to create a hosted zone using a reusable delegation set, you could specify an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone, instead of alloting a new one.
" - }, - "CreateReusableDelegationSet":{ - "name":"CreateReusableDelegationSet", - "http":{ - "method":"POST", - "requestUri":"/2013-04-01/delegationset", - "responseCode":201 - }, - "input":{ - "shape":"CreateReusableDelegationSetRequest", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"CreateReusableDelegationSetRequest" - }, - "output":{"shape":"CreateReusableDelegationSetResponse"}, - "errors":[ - { - "shape":"DelegationSetAlreadyCreated", - "exception":true, - "documentation":"A delegation set with the same owner and caller reference combination has already been created.
" - }, - { - "shape":"LimitsExceeded", - "exception":true, - "documentation":"The limits specified for a resource have been exceeded.
" - }, - { - "shape":"HostedZoneNotFound", - "exception":true, - "documentation":"The specified HostedZone cannot be found.
" - }, - { - "shape":"InvalidArgument", - "exception":true, - "documentation":"At least one of the specified arguments is invalid.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"DelegationSetNotAvailable", - "exception":true, - "documentation":"Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
" - }, - { - "shape":"DelegationSetAlreadyReusable", - "exception":true, - "documentation":"The specified delegation set has already been marked as reusable.
" - } - ], - "documentation":"This action creates a reusable delegationSet.
To create a new reusable delegationSet, send a POST request to the 2013-04-01/delegationset resource. The request body must include an XML document with a CreateReusableDelegationSetRequest element. The response returns the CreateReusableDelegationSetResponse element that contains metadata about the delegationSet.
If the optional parameter HostedZoneId is specified, it marks the delegationSet associated with that particular hosted zone as reusable.
" - }, - "DeleteHealthCheck":{ - "name":"DeleteHealthCheck", - "http":{ - "method":"DELETE", - "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" - }, - "input":{ - "shape":"DeleteHealthCheckRequest", - "documentation":"A complex type containing the request information for delete health check.
" - }, - "output":{ - "shape":"DeleteHealthCheckResponse", - "documentation":"Empty response for the request.
" - }, - "errors":[ - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"HealthCheckInUse", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"This action deletes a health check. To delete a health check, send a DELETE request to the 2013-04-01/healthcheck/health check ID resource.
HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.A complex type that contains information about the hosted zone that you want to delete.
" - }, - "output":{ - "shape":"DeleteHostedZoneResponse", - "documentation":"A complex type containing the response information for the request.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"HostedZoneNotEmpty", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.
" - }, - { - "shape":"PriorRequestNotComplete", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request was rejected because Route 53 was still processing a prior request.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the 2013-04-01/hostedzone/hosted zone ID resource.
For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide.
HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.A complex type containing the information for the delete request.
" - }, - "output":{ - "shape":"DeleteReusableDelegationSetResponse", - "documentation":"Empty response for the request.
" - }, - "errors":[ - { - "shape":"NoSuchDelegationSet", - "exception":true, - "documentation":"The specified delegation set does not exist.
" - }, - { - "shape":"DelegationSetInUse", - "exception":true, - "documentation":"The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
" - }, - { - "shape":"DelegationSetNotReusable", - "exception":true, - "documentation":"The specified delegation set has not been marked as reusable.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"This action deletes a reusable delegation set. To delete a reusable delegation set, send a DELETE request to the 2013-04-01/delegationset/delegation set ID resource.
DelegationSetInUse error.A complex type that contains information about the request to disassociate a VPC from an hosted zone.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"DisassociateVPCFromHostedZoneRequest" - }, - "output":{ - "shape":"DisassociateVPCFromHostedZoneResponse", - "documentation":"A complex type containing the response information for the request.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"InvalidVPCId", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone you are trying to create for your VPC_ID does not belong to you. Route 53 returns this error when the VPC specified by VPCId does not belong to you.
The VPC you specified is not currently associated with the hosted zone.
" - }, - { - "shape":"LastVPCAssociation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Route 53 currently doesn't support disassociate the last VPC from the hosted zone.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"This action disassociates a VPC from an hosted zone.
To disassociate a VPC to a hosted zone, send a POST request to the 2013-04-01/hostedzone/hosted zone ID/disassociatevpc resource. The request body must include an XML document with a DisassociateVPCFromHostedZoneRequest element. The response returns the DisassociateVPCFromHostedZoneResponse element that contains ChangeInfo for you to track the progress of the DisassociateVPCFromHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.
The input for a GetChange request.
" - }, - "output":{ - "shape":"GetChangeResponse", - "documentation":"A complex type that contains the ChangeInfo element.
Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"This action returns the current status of a change batch request. The status is one of the following values:
- PENDING indicates that the changes in this request have not replicated to all Route 53 DNS servers. This is the initial status of all change batch requests.
- INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.
Empty request.
" - }, - "output":{ - "shape":"GetCheckerIpRangesResponse", - "documentation":"A complex type that contains the CheckerIpRanges element.
To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send a GET request to the 2013-04-01/checkeripranges resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.
A complex type that contains information about the request to get a geo location.
" - }, - "output":{ - "shape":"GetGeoLocationResponse", - "documentation":"A complex type containing information about the specified geo location.
" - }, - "errors":[ - { - "shape":"NoSuchGeoLocation", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The geo location you are trying to get does not exist.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":" To retrieve a single geo location, send a GET request to the 2013-04-01/geolocation resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.
A complex type that contains information about the request to get a health check.
" - }, - "output":{ - "shape":"GetHealthCheckResponse", - "documentation":"A complex type containing information about the specified health check.
" - }, - "errors":[ - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"IncompatibleVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
" - } - ], - "documentation":" To retrieve the health check, send a GET request to the 2013-04-01/healthcheck/health check ID resource.
To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.
A complex type that contains the count of health checks associated with the current AWS account.
" - }, - "documentation":" To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.
A complex type that contains information about the request to get the most recent failure reason for a health check.
" - }, - "output":{ - "shape":"GetHealthCheckLastFailureReasonResponse", - "documentation":"A complex type that contains information about the most recent failure for the specified health check.
" - }, - "errors":[ - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - } - ], - "documentation":"If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can get the failure reason for the most recent failure. Send a GET request to the 2013-04-01/healthcheck/health check ID/lastfailurereason resource.
A complex type that contains information about the request to get health check status for a health check.
" - }, - "output":{ - "shape":"GetHealthCheckStatusResponse", - "documentation":"A complex type that contains information about the status of the specified health check.
" - }, - "errors":[ - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - } - ], - "documentation":" To retrieve the health check status, send a GET request to the 2013-04-01/healthcheck/health check ID/status resource. You can use this call to get a health check's current status.
The input for a GetHostedZone request.
" - }, - "output":{ - "shape":"GetHostedZoneResponse", - "documentation":"A complex type containing information about the specified hosted zone.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":" To retrieve the delegation set for a hosted zone, send a GET request to the 2013-04-01/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.
The input for a GetReusableDelegationSet request.
" - }, - "output":{ - "shape":"GetReusableDelegationSetResponse", - "documentation":"A complex type containing information about the specified reusable delegation set.
" - }, - "errors":[ - { - "shape":"NoSuchDelegationSet", - "exception":true, - "documentation":"The specified delegation set does not exist.
" - }, - { - "shape":"DelegationSetNotReusable", - "exception":true, - "documentation":"The specified delegation set has not been marked as reusable.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":" To retrieve the reusable delegation set, send a GET request to the 2013-04-01/delegationset/delegation set ID resource.
The input for a ListGeoLocations request.
" - }, - "output":{ - "shape":"ListGeoLocationsResponse", - "documentation":"A complex type that contains information about the geo locations that are returned by the request and information about the response.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":" To retrieve a list of supported geo locations, send a GET request to the 2013-04-01/geolocations resource. The response to this request includes a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list.
By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. If the list is truncated, IsTruncated will be set to true and a combination of NextContinentCode, NextCountryCode, NextSubdivisionCode will be populated. You can pass these as parameters to StartContinentCode, StartCountryCode, StartSubdivisionCode to control the geo location that the list begins with.
To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
MaxItems to a value greater than 100, Route 53 returns only the first 100.A complex type that contains the response for the request.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"IncompatibleVersion", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
" - } - ], - "documentation":" To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.
MaxItems to a value greater than 100, Route 53 returns only the first 100.A complex type that contains the response for the request.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"NoSuchDelegationSet", - "exception":true, - "documentation":"The specified delegation set does not exist.
" - }, - { - "shape":"DelegationSetNotReusable", - "exception":true, - "documentation":"The specified delegation set has not been marked as reusable.
" - } - ], - "documentation":" To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.
The input for a ListResourceRecordSets request.
" - }, - "output":{ - "shape":"ListResourceRecordSetsResponse", - "documentation":"A complex type that contains information about the resource record sets that are returned by the request and information about the response.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":"Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like \"com.amazon.www\" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments:
Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1
To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response.
In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress.
However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic)
The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process.
" - }, - "ListReusableDelegationSets":{ - "name":"ListReusableDelegationSets", - "http":{ - "method":"GET", - "requestUri":"/2013-04-01/delegationset" - }, - "input":{ - "shape":"ListReusableDelegationSetsRequest", - "documentation":" To retrieve a list of your reusable delegation sets, send a GET request to the 2013-04-01/delegationset resource. The response to this request includes a DelegationSets element with zero or more DelegationSet child elements. By default, the list of reusable delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with.
MaxItems to a value greater than 100, Route 53 returns only the first 100.A complex type that contains the response for the request.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":" To retrieve a list of your reusable delegation sets, send a GET request to the 2013-04-01/delegationset resource. The response to this request includes a DelegationSets element with zero, one, or multiple DelegationSet child elements. By default, the list of delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with.
A complex type containing information about a request for a list of the tags that are associated with an individual resource.
" - }, - "output":{ - "shape":"ListTagsForResourceResponse", - "documentation":"A complex type containing tags for the specified resource.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"PriorRequestNotComplete", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request was rejected because Route 53 was still processing a prior request.
" - }, - { - "shape":"ThrottlingException", - "error":{"httpStatusCode":400}, - "exception":true - } - ] - }, - "ListTagsForResources":{ - "name":"ListTagsForResources", - "http":{ - "method":"POST", - "requestUri":"/2013-04-01/tags/{ResourceType}" - }, - "input":{ - "shape":"ListTagsForResourcesRequest", - "documentation":"A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"ListTagsForResourcesRequest" - }, - "output":{ - "shape":"ListTagsForResourcesResponse", - "documentation":"A complex type containing tags for the specified resources.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"PriorRequestNotComplete", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request was rejected because Route 53 was still processing a prior request.
" - }, - { - "shape":"ThrottlingException", - "error":{"httpStatusCode":400}, - "exception":true - } - ] - }, - "UpdateHealthCheck":{ - "name":"UpdateHealthCheck", - "http":{ - "method":"POST", - "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" - }, - "input":{ - "shape":"UpdateHealthCheckRequest", - "documentation":">A complex type that contains information about the request to update a health check.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"UpdateHealthCheckRequest" - }, - "output":{"shape":"UpdateHealthCheckResponse"}, - "errors":[ - { - "shape":"NoSuchHealthCheck", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - { - "shape":"HealthCheckVersionMismatch", - "error":{"httpStatusCode":409}, - "exception":true - } - ], - "documentation":"This action updates an existing health check.
To update a health check, send a POST request to the 2013-04-01/healthcheck/health check ID resource. The request body must include an XML document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.
A complex type that contains information about the request to update a hosted zone comment.
", - "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"}, - "locationName":"UpdateHostedZoneCommentRequest" - }, - "output":{ - "shape":"UpdateHostedZoneCommentResponse", - "documentation":"A complex type containing information about the specified hosted zone after the update.
" - }, - "errors":[ - { - "shape":"NoSuchHostedZone", - "error":{"httpStatusCode":404}, - "exception":true - }, - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - } - ], - "documentation":" To update the hosted zone comment, send a POST request to the 2013-04-01/hostedzone/hosted zone ID resource. The request body must include an XML document with a UpdateHostedZoneCommentRequest element. The response to this request includes the modified HostedZone element.
Alias resource record sets only: The value of the hosted zone ID for the AWS resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
." - }, - "DNSName":{ - "shape":"DNSName", - "documentation":"Alias resource record sets only: The external DNS name associated with the AWS Resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
." - }, - "EvaluateTargetHealth":{ - "shape":"AliasHealthEnabled", - "documentation":"Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
." - } - }, - "documentation":"Alias resource record sets only: Information about the domain to which you are redirecting traffic.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
." - }, - "AssociateVPCComment":{"type":"string"}, - "AssociateVPCWithHostedZoneRequest":{ - "type":"structure", - "required":[ - "HostedZoneId", - "VPC" - ], - "members":{ - "HostedZoneId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone you want to associate your VPC with.
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
" - }, - "VPC":{ - "shape":"VPC", - "documentation":"The VPC that you want your hosted zone to be associated with.
" - }, - "Comment":{ - "shape":"AssociateVPCComment", - "documentation":"Optional: Any comments you want to include about a AssociateVPCWithHostedZoneRequest.
A complex type that contains information about the request to associate a VPC with an hosted zone.
" - }, - "AssociateVPCWithHostedZoneResponse":{ - "type":"structure", - "required":["ChangeInfo"], - "members":{ - "ChangeInfo":{ - "shape":"ChangeInfo", - "documentation":"A complex type that contains the ID, the status, and the date and time of your AssociateVPCWithHostedZoneRequest.
A complex type containing the response information for the request.
" - }, - "Change":{ - "type":"structure", - "required":[ - "Action", - "ResourceRecordSet" - ], - "members":{ - "Action":{ - "shape":"ChangeAction", - "documentation":"The action to perform.
Valid values: CREATE | DELETE | UPSERT
Information about the resource record set to create or delete.
" - } - }, - "documentation":"A complex type that contains the information for each change in a change batch request.
" - }, - "ChangeAction":{ - "type":"string", - "enum":[ - "CREATE", - "DELETE", - "UPSERT" - ] - }, - "ChangeBatch":{ - "type":"structure", - "required":["Changes"], - "members":{ - "Comment":{ - "shape":"ResourceDescription", - "documentation":"Optional: Any comments you want to include about a change batch request.
" - }, - "Changes":{ - "shape":"Changes", - "documentation":"A complex type that contains one Change element for each resource record set that you want to create or delete.
A complex type that contains an optional comment and the changes that you want to make with a change batch request.
" - }, - "ChangeInfo":{ - "type":"structure", - "required":[ - "Id", - "Status", - "SubmittedAt" - ], - "members":{ - "Id":{ - "shape":"ResourceId", - "documentation":"The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
" - }, - "Status":{ - "shape":"ChangeStatus", - "documentation":"The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
" - } - }, - "documentation":"A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
" - }, - "ChangeResourceRecordSetsRequest":{ - "type":"structure", - "required":[ - "HostedZoneId", - "ChangeBatch" - ], - "members":{ - "HostedZoneId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone that contains the resource record sets that you want to change.
" - }, - "ChangeBatch":{ - "shape":"ChangeBatch", - "documentation":"A complex type that contains an optional comment and the Changes element.
A complex type that contains a change batch.
" - }, - "ChangeResourceRecordSetsResponse":{ - "type":"structure", - "required":["ChangeInfo"], - "members":{ - "ChangeInfo":{ - "shape":"ChangeInfo", - "documentation":"A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
" - } - }, - "documentation":"A complex type containing the response for the request.
" - }, - "ChangeStatus":{ - "type":"string", - "enum":[ - "PENDING", - "INSYNC" - ] - }, - "ChangeTagsForResourceRequest":{ - "type":"structure", - "required":[ - "ResourceType", - "ResourceId" - ], - "members":{ - "ResourceType":{ - "shape":"TagResourceType", - "location":"uri", - "locationName":"ResourceType", - "documentation":"The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The ID of the resource for which you want to add, change, or delete tags.
" - }, - "AddTags":{ - "shape":"TagList", - "documentation":"A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.
A list of Tag keys that you want to remove from the specified resource.
A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.
" - }, - "ChangeTagsForResourceResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"Empty response for the request.
" - }, - "Changes":{ - "type":"list", - "member":{ - "shape":"Change", - "locationName":"Change" - }, - "min":1 - }, - "CheckerIpRanges":{ - "type":"list", - "member":{"shape":"IPAddressCidr"} - }, - "ConflictingDomainExists":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "CreateHealthCheckRequest":{ - "type":"structure", - "required":[ - "CallerReference", - "HealthCheckConfig" - ], - "members":{ - "CallerReference":{ - "shape":"HealthCheckNonce", - "documentation":"A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
" - }, - "HealthCheckConfig":{ - "shape":"HealthCheckConfig", - "documentation":"A complex type that contains health check configuration.
" - } - }, - "documentation":">A complex type that contains information about the request to create a health check.
" - }, - "CreateHealthCheckResponse":{ - "type":"structure", - "required":[ - "HealthCheck", - "Location" - ], - "members":{ - "HealthCheck":{ - "shape":"HealthCheck", - "documentation":"A complex type that contains identifying information about the health check.
" - }, - "Location":{ - "shape":"ResourceURI", - "location":"header", - "locationName":"Location", - "documentation":"The unique URL representing the new health check.
" - } - }, - "documentation":"A complex type containing the response information for the new health check.
" - }, - "CreateHostedZoneRequest":{ - "type":"structure", - "required":[ - "Name", - "CallerReference" - ], - "members":{ - "Name":{ - "shape":"DNSName", - "documentation":"The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
" - }, - "CallerReference":{ - "shape":"Nonce", - "documentation":"A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
" - }, - "HostedZoneConfig":{ - "shape":"HostedZoneConfig", - "documentation":"A complex type that contains an optional comment about your hosted zone.
" - }, - "DelegationSetId":{ - "shape":"ResourceId", - "documentation":"The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.
" - } - }, - "documentation":"A complex type that contains information about the request to create a hosted zone.
" - }, - "CreateHostedZoneResponse":{ - "type":"structure", - "required":[ - "HostedZone", - "ChangeInfo", - "DelegationSet", - "Location" - ], - "members":{ - "HostedZone":{ - "shape":"HostedZone", - "documentation":"A complex type that contains identifying information about the hosted zone.
" - }, - "ChangeInfo":{ - "shape":"ChangeInfo", - "documentation":"A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.
" - }, - "DelegationSet":{ - "shape":"DelegationSet", - "documentation":"A complex type that contains name server information.
" - }, - "VPC":{"shape":"VPC"}, - "Location":{ - "shape":"ResourceURI", - "location":"header", - "locationName":"Location", - "documentation":"The unique URL representing the new hosted zone.
" - } - }, - "documentation":"A complex type containing the response information for the new hosted zone.
" - }, - "CreateReusableDelegationSetRequest":{ - "type":"structure", - "required":["CallerReference"], - "members":{ - "CallerReference":{ - "shape":"Nonce", - "documentation":"A unique string that identifies the request and that allows failed CreateReusableDelegationSet requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a reusable delegation set. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
" - }, - "HostedZoneId":{ - "shape":"ResourceId", - "documentation":"The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.
" - } - } - }, - "CreateReusableDelegationSetResponse":{ - "type":"structure", - "required":[ - "DelegationSet", - "Location" - ], - "members":{ - "DelegationSet":{ - "shape":"DelegationSet", - "documentation":"A complex type that contains name server information.
" - }, - "Location":{ - "shape":"ResourceURI", - "location":"header", - "locationName":"Location", - "documentation":"The unique URL representing the new reusbale delegation set.
" - } - } - }, - "DNSName":{ - "type":"string", - "max":1024 - }, - "DelegationSet":{ - "type":"structure", - "required":["NameServers"], - "members":{ - "Id":{"shape":"ResourceId"}, - "CallerReference":{"shape":"Nonce"}, - "NameServers":{ - "shape":"DelegationSetNameServers", - "documentation":"A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
A complex type that contains name server information.
" - }, - "DelegationSetAlreadyCreated":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"A delegation set with the same owner and caller reference combination has already been created.
" - }, - "DelegationSetAlreadyReusable":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"The specified delegation set has already been marked as reusable.
" - }, - "DelegationSetInUse":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
" - }, - "DelegationSetNameServers":{ - "type":"list", - "member":{ - "shape":"DNSName", - "locationName":"NameServer" - }, - "min":1 - }, - "DelegationSetNotAvailable":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
" - }, - "DelegationSetNotReusable":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"The specified delegation set has not been marked as reusable.
" - }, - "DelegationSets":{ - "type":"list", - "member":{ - "shape":"DelegationSet", - "locationName":"DelegationSet" - } - }, - "DeleteHealthCheckRequest":{ - "type":"structure", - "required":["HealthCheckId"], - "members":{ - "HealthCheckId":{ - "shape":"HealthCheckId", - "location":"uri", - "locationName":"HealthCheckId", - "documentation":"The ID of the health check to delete.
" - } - }, - "documentation":"A complex type containing the request information for delete health check.
" - }, - "DeleteHealthCheckResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"Empty response for the request.
" - }, - "DeleteHostedZoneRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone you want to delete.
" - } - }, - "documentation":"A complex type that contains information about the hosted zone that you want to delete.
" - }, - "DeleteHostedZoneResponse":{ - "type":"structure", - "required":["ChangeInfo"], - "members":{ - "ChangeInfo":{ - "shape":"ChangeInfo", - "documentation":"A complex type that contains the ID, the status, and the date and time of your delete request.
" - } - }, - "documentation":"A complex type containing the response information for the request.
" - }, - "DeleteReusableDelegationSetRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the reusable delegation set you want to delete.
" - } - }, - "documentation":"A complex type containing the information for the delete request.
" - }, - "DeleteReusableDelegationSetResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"Empty response for the request.
" - }, - "DisassociateVPCComment":{"type":"string"}, - "DisassociateVPCFromHostedZoneRequest":{ - "type":"structure", - "required":[ - "HostedZoneId", - "VPC" - ], - "members":{ - "HostedZoneId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone you want to disassociate your VPC from.
Note that you cannot disassociate the last VPC from a hosted zone.
" - }, - "VPC":{ - "shape":"VPC", - "documentation":"The VPC that you want your hosted zone to be disassociated from.
" - }, - "Comment":{ - "shape":"DisassociateVPCComment", - "documentation":"Optional: Any comments you want to include about a DisassociateVPCFromHostedZoneRequest.
A complex type that contains information about the request to disassociate a VPC from an hosted zone.
" - }, - "DisassociateVPCFromHostedZoneResponse":{ - "type":"structure", - "required":["ChangeInfo"], - "members":{ - "ChangeInfo":{ - "shape":"ChangeInfo", - "documentation":"A complex type that contains the ID, the status, and the date and time of your DisassociateVPCFromHostedZoneRequest.
A complex type containing the response information for the request.
" - }, - "ErrorMessage":{"type":"string"}, - "ErrorMessages":{ - "type":"list", - "member":{ - "shape":"ErrorMessage", - "locationName":"Message" - } - }, - "FailureThreshold":{ - "type":"integer", - "min":1, - "max":10 - }, - "FullyQualifiedDomainName":{ - "type":"string", - "max":255 - }, - "GeoLocation":{ - "type":"structure", - "members":{ - "ContinentCode":{ - "shape":"GeoLocationContinentCode", - "documentation":"The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
A complex type that contains information about a geo location.
" - }, - "GeoLocationContinentCode":{ - "type":"string", - "min":2, - "max":2 - }, - "GeoLocationContinentName":{ - "type":"string", - "min":1, - "max":32 - }, - "GeoLocationCountryCode":{ - "type":"string", - "min":1, - "max":2 - }, - "GeoLocationCountryName":{ - "type":"string", - "min":1, - "max":64 - }, - "GeoLocationDetails":{ - "type":"structure", - "members":{ - "ContinentCode":{ - "shape":"GeoLocationContinentCode", - "documentation":"The code for a continent geo location. Note: only continent locations have a continent code.
" - }, - "ContinentName":{ - "shape":"GeoLocationContinentName", - "documentation":"The name of the continent. This element is only present if ContinentCode is also present.
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The name of the country. This element is only present if CountryCode is also present.
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
" - }, - "SubdivisionName":{ - "shape":"GeoLocationSubdivisionName", - "documentation":"The name of the subdivision. This element is only present if SubdivisionCode is also present.
A complex type that contains information about a GeoLocation.
The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.
The input for a GetChange request.
" - }, - "GetChangeResponse":{ - "type":"structure", - "required":["ChangeInfo"], - "members":{ - "ChangeInfo":{ - "shape":"ChangeInfo", - "documentation":"A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.
" - } - }, - "documentation":"A complex type that contains the ChangeInfo element.
Empty request.
" - }, - "GetCheckerIpRangesResponse":{ - "type":"structure", - "required":["CheckerIpRanges"], - "members":{ - "CheckerIpRanges":{ - "shape":"CheckerIpRanges", - "documentation":"A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
" - } - }, - "documentation":"A complex type that contains the CheckerIpRanges element.
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
A complex type that contains information about the request to get a geo location.
" - }, - "GetGeoLocationResponse":{ - "type":"structure", - "required":["GeoLocationDetails"], - "members":{ - "GeoLocationDetails":{ - "shape":"GeoLocationDetails", - "documentation":"A complex type that contains the information about the specified geo location.
" - } - }, - "documentation":"A complex type containing information about the specified geo location.
" - }, - "GetHealthCheckCountRequest":{ - "type":"structure", - "members":{ - }, - "documentation":" To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.
The number of health checks associated with the current AWS account.
" - } - }, - "documentation":"A complex type that contains the count of health checks associated with the current AWS account.
" - }, - "GetHealthCheckLastFailureReasonRequest":{ - "type":"structure", - "required":["HealthCheckId"], - "members":{ - "HealthCheckId":{ - "shape":"HealthCheckId", - "location":"uri", - "locationName":"HealthCheckId", - "documentation":"The ID of the health check for which you want to retrieve the reason for the most recent failure.
" - } - }, - "documentation":"A complex type that contains information about the request to get the most recent failure reason for a health check.
" - }, - "GetHealthCheckLastFailureReasonResponse":{ - "type":"structure", - "required":["HealthCheckObservations"], - "members":{ - "HealthCheckObservations":{ - "shape":"HealthCheckObservations", - "documentation":"A list that contains one HealthCheckObservation element for each Route 53 health checker.
A complex type that contains information about the most recent failure for the specified health check.
" - }, - "GetHealthCheckRequest":{ - "type":"structure", - "required":["HealthCheckId"], - "members":{ - "HealthCheckId":{ - "shape":"HealthCheckId", - "location":"uri", - "locationName":"HealthCheckId", - "documentation":"The ID of the health check to retrieve.
" - } - }, - "documentation":"A complex type that contains information about the request to get a health check.
" - }, - "GetHealthCheckResponse":{ - "type":"structure", - "required":["HealthCheck"], - "members":{ - "HealthCheck":{ - "shape":"HealthCheck", - "documentation":"A complex type that contains the information about the specified health check.
" - } - }, - "documentation":"A complex type containing information about the specified health check.
" - }, - "GetHealthCheckStatusRequest":{ - "type":"structure", - "required":["HealthCheckId"], - "members":{ - "HealthCheckId":{ - "shape":"HealthCheckId", - "location":"uri", - "locationName":"HealthCheckId", - "documentation":"The ID of the health check for which you want to retrieve the most recent status.
" - } - }, - "documentation":"A complex type that contains information about the request to get health check status for a health check.
" - }, - "GetHealthCheckStatusResponse":{ - "type":"structure", - "required":["HealthCheckObservations"], - "members":{ - "HealthCheckObservations":{ - "shape":"HealthCheckObservations", - "documentation":"A list that contains one HealthCheckObservation element for each Route 53 health checker.
A complex type that contains information about the status of the specified health check.
" - }, - "GetHostedZoneRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
" - } - }, - "documentation":"The input for a GetHostedZone request.
" - }, - "GetHostedZoneResponse":{ - "type":"structure", - "required":["HostedZone"], - "members":{ - "HostedZone":{ - "shape":"HostedZone", - "documentation":"A complex type that contains the information about the specified hosted zone.
" - }, - "DelegationSet":{ - "shape":"DelegationSet", - "documentation":"A complex type that contains information about the name servers for the specified hosted zone.
" - }, - "VPCs":{ - "shape":"VPCs", - "documentation":"A complex type that contains information about VPCs associated with the specified hosted zone.
" - } - }, - "documentation":"A complex type containing information about the specified hosted zone.
" - }, - "GetReusableDelegationSetRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the reusable delegation set for which you want to get a list of the name server.
" - } - }, - "documentation":"The input for a GetReusableDelegationSet request.
" - }, - "GetReusableDelegationSetResponse":{ - "type":"structure", - "required":["DelegationSet"], - "members":{ - "DelegationSet":{ - "shape":"DelegationSet", - "documentation":"A complex type that contains the information about the nameservers for the specified delegation set ID.
" - } - }, - "documentation":"A complex type containing information about the specified reusable delegation set.
" - }, - "HealthCheck":{ - "type":"structure", - "required":[ - "Id", - "CallerReference", - "HealthCheckConfig", - "HealthCheckVersion" - ], - "members":{ - "Id":{ - "shape":"HealthCheckId", - "documentation":"The ID of the specified health check.
" - }, - "CallerReference":{ - "shape":"HealthCheckNonce", - "documentation":"A unique string that identifies the request to create the health check.
" - }, - "HealthCheckConfig":{ - "shape":"HealthCheckConfig", - "documentation":"A complex type that contains the health check configuration.
" - }, - "HealthCheckVersion":{ - "shape":"HealthCheckVersion", - "documentation":"The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
A complex type that contains identifying information about the health check.
" - }, - "HealthCheckAlreadyExists":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The health check you are trying to create already exists. Route 53 returns this error when a health check has already been created with the specified CallerReference.
IP Address of the instance being checked.
" - }, - "Port":{ - "shape":"Port", - "documentation":"Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
" - }, - "Type":{ - "shape":"HealthCheckType", - "documentation":"The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
" - }, - "ResourcePath":{ - "shape":"ResourcePath", - "documentation":"Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
" - }, - "FullyQualifiedDomainName":{ - "shape":"FullyQualifiedDomainName", - "documentation":"Fully qualified domain name of the instance to be health checked.
" - }, - "SearchString":{ - "shape":"SearchString", - "documentation":"A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
" - }, - "RequestInterval":{ - "shape":"RequestInterval", - "documentation":"The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
" - }, - "FailureThreshold":{ - "shape":"FailureThreshold", - "documentation":"The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the Amazon Route 53 Developer Guide.
" - } - }, - "documentation":"A complex type that contains the health check configuration.
" - }, - "HealthCheckCount":{"type":"long"}, - "HealthCheckId":{ - "type":"string", - "max":64 - }, - "HealthCheckInUse":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.
" - }, - "HealthCheckNonce":{ - "type":"string", - "min":1, - "max":64 - }, - "HealthCheckObservation":{ - "type":"structure", - "members":{ - "IPAddress":{ - "shape":"IPAddress", - "documentation":"The IP address of the Route 53 health checker that performed the health check.
" - }, - "StatusReport":{ - "shape":"StatusReport", - "documentation":"A complex type that contains information about the health check status for the current observation.
" - } - }, - "documentation":"A complex type that contains the IP address of a Route 53 health checker and the reason for the health check status.
" - }, - "HealthCheckObservations":{ - "type":"list", - "member":{ - "shape":"HealthCheckObservation", - "locationName":"HealthCheckObservation" - } - }, - "HealthCheckType":{ - "type":"string", - "enum":[ - "HTTP", - "HTTPS", - "HTTP_STR_MATCH", - "HTTPS_STR_MATCH", - "TCP" - ] - }, - "HealthCheckVersion":{ - "type":"long", - "min":1 - }, - "HealthCheckVersionMismatch":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":409}, - "exception":true - }, - "HealthChecks":{ - "type":"list", - "member":{ - "shape":"HealthCheck", - "locationName":"HealthCheck" - } - }, - "HostedZone":{ - "type":"structure", - "required":[ - "Id", - "Name", - "CallerReference" - ], - "members":{ - "Id":{ - "shape":"ResourceId", - "documentation":"The ID of the specified hosted zone.
" - }, - "Name":{ - "shape":"DNSName", - "documentation":"The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
A unique string that identifies the request to create the hosted zone.
" - }, - "Config":{ - "shape":"HostedZoneConfig", - "documentation":"A complex type that contains the Comment element.
Total number of resource record sets in the hosted zone.
" - } - }, - "documentation":"A complex type that contain information about the specified hosted zone.
" - }, - "HostedZoneAlreadyExists":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":409}, - "exception":true, - "documentation":"The hosted zone you are trying to create already exists. Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.
An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
" - } - }, - "documentation":"A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.
" - }, - "HostedZoneNotFound":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"The specified HostedZone cannot be found.
" - }, - "HostedZoneRRSetCount":{"type":"long"}, - "HostedZones":{ - "type":"list", - "member":{ - "shape":"HostedZone", - "locationName":"HostedZone" - } - }, - "IPAddress":{ - "type":"string", - "max":15, - "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" - }, - "IPAddressCidr":{"type":"string"}, - "IncompatibleVersion":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
" - }, - "InvalidArgument":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"At least one of the specified arguments is invalid.
" - }, - "InvalidChangeBatch":{ - "type":"structure", - "members":{ - "messages":{ - "shape":"ErrorMessages", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.
" - }, - "InvalidDomainName":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This error indicates that the specified domain name is not valid.
" - }, - "InvalidInput":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Some value specified in the request is invalid or the XML document is malformed.
" - }, - "InvalidVPCId":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone you are trying to create for your VPC_ID does not belong to you. Route 53 returns this error when the VPC specified by VPCId does not belong to you.
Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Route 53 currently doesn't support disassociate the last VPC from the hosted zone.
" - }, - "LimitsExceeded":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"The limits specified for a resource have been exceeded.
" - }, - "ListGeoLocationsRequest":{ - "type":"structure", - "members":{ - "StartContinentCode":{ - "shape":"GeoLocationContinentCode", - "location":"querystring", - "locationName":"startcontinentcode", - "documentation":"The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
The maximum number of geo locations you want in the response body.
" - } - }, - "documentation":"The input for a ListGeoLocations request.
" - }, - "ListGeoLocationsResponse":{ - "type":"structure", - "required":[ - "GeoLocationDetailsList", - "IsTruncated", - "MaxItems" - ], - "members":{ - "GeoLocationDetailsList":{ - "shape":"GeoLocationDetailsList", - "documentation":"A complex type that contains information about the geo locations that are returned by the request.
" - }, - "IsTruncated":{ - "shape":"PageTruncated", - "documentation":"A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.
Valid Values: true | false
If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.
" - }, - "NextCountryCode":{ - "shape":"GeoLocationCountryCode", - "documentation":"If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.
" - }, - "NextSubdivisionCode":{ - "shape":"GeoLocationSubdivisionCode", - "documentation":"If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.
" - }, - "MaxItems":{ - "shape":"PageMaxItems", - "documentation":"The maximum number of records you requested. The maximum value of MaxItems is 100.
A complex type that contains information about the geo locations that are returned by the request and information about the response.
" - }, - "ListHealthChecksRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"PageMarker", - "location":"querystring", - "locationName":"marker", - "documentation":"If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
Specify the maximum number of health checks to return per page of results.
" - } - }, - "documentation":" To retrieve a list of your health checks, send a GET request to the 2013-04-01/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
MaxItems to a value greater than 100, Route 53 returns only the first 100.A complex type that contains information about the health checks associated with the current AWS account.
" - }, - "Marker":{ - "shape":"PageMarker", - "documentation":"If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.
The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
A complex type that contains the response for the request.
" - }, - "ListHostedZonesRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"PageMarker", - "location":"querystring", - "locationName":"marker", - "documentation":"If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
Specify the maximum number of hosted zones to return per page of results.
" - }, - "DelegationSetId":{ - "shape":"ResourceId", - "location":"querystring", - "locationName":"delegationsetid" - } - }, - "documentation":" To retrieve a list of your hosted zones, send a GET request to the 2013-04-01/hostedzone resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.
MaxItems to a value greater than 100, Route 53 returns only the first 100.A complex type that contains information about the hosted zones associated with the current AWS account.
" - }, - "Marker":{ - "shape":"PageMarker", - "documentation":"If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.
The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesResponse$IsTruncated in the response is true. Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
A complex type that contains the response for the request.
" - }, - "ListResourceRecordSetsRequest":{ - "type":"structure", - "required":["HostedZoneId"], - "members":{ - "HostedZoneId":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone that contains the resource record sets that you want to get.
" - }, - "StartRecordName":{ - "shape":"DNSName", - "location":"querystring", - "locationName":"name", - "documentation":"The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
The DNS type at which to begin the listing of resource record sets.
Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT
Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT
Values for Alias Resource Record Sets: A | AAAA
Constraint: Specifying type without specifying name returns an InvalidInput error.
Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
The maximum number of records you want in the response body.
" - } - }, - "documentation":"The input for a ListResourceRecordSets request.
" - }, - "ListResourceRecordSetsResponse":{ - "type":"structure", - "required":[ - "ResourceRecordSets", - "IsTruncated", - "MaxItems" - ], - "members":{ - "ResourceRecordSets":{ - "shape":"ResourceRecordSets", - "documentation":"A complex type that contains information about the resource record sets that are returned by the request.
" - }, - "IsTruncated":{ - "shape":"PageTruncated", - "documentation":"A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.
Valid Values: true | false
If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
" - }, - "NextRecordType":{ - "shape":"RRType", - "documentation":"If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
" - }, - "NextRecordIdentifier":{ - "shape":"ResourceRecordSetIdentifier", - "documentation":"Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.
The maximum number of records you requested. The maximum value of MaxItems is 100.
A complex type that contains information about the resource record sets that are returned by the request and information about the response.
" - }, - "ListReusableDelegationSetsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"PageMarker", - "location":"querystring", - "locationName":"marker", - "documentation":"If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
Specify the maximum number of reusable delegation sets to return per page of results.
" - } - }, - "documentation":" To retrieve a list of your reusable delegation sets, send a GET request to the 2013-04-01/delegationset resource. The response to this request includes a DelegationSets element with zero or more DelegationSet child elements. By default, the list of reusable delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with.
MaxItems to a value greater than 100, Route 53 returns only the first 100.A complex type that contains information about the reusable delegation sets associated with the current AWS account.
" - }, - "Marker":{ - "shape":"PageMarker", - "documentation":"If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
A flag indicating whether there are more reusable delegation sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
Indicates where to continue listing reusable delegation sets. If ListReusableDelegationSetsResponse$IsTruncated is true, make another request to ListReusableDelegationSets and include the value of the NextMarker element in the Marker element to get the next page of results.
The maximum number of reusable delegation sets to be included in the response body. If the number of reusable delegation sets associated with this AWS account exceeds MaxItems, the value of ListReusablDelegationSetsResponse$IsTruncated in the response is true. Call ListReusableDelegationSets again and specify the value of ListReusableDelegationSetsResponse$NextMarker in the ListReusableDelegationSetsRequest$Marker element to get the next page of results.
A complex type that contains the response for the request.
" - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":[ - "ResourceType", - "ResourceId" - ], - "members":{ - "ResourceType":{ - "shape":"TagResourceType", - "location":"uri", - "locationName":"ResourceType", - "documentation":"The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The ID of the resource for which you want to retrieve tags.
" - } - }, - "documentation":"A complex type containing information about a request for a list of the tags that are associated with an individual resource.
" - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "required":["ResourceTagSet"], - "members":{ - "ResourceTagSet":{ - "shape":"ResourceTagSet", - "documentation":"A ResourceTagSet containing tags associated with the specified resource.
A complex type containing tags for the specified resource.
" - }, - "ListTagsForResourcesRequest":{ - "type":"structure", - "required":[ - "ResourceType", - "ResourceIds" - ], - "members":{ - "ResourceType":{ - "shape":"TagResourceType", - "location":"uri", - "locationName":"ResourceType", - "documentation":"The type of the resources.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
" - } - }, - "documentation":"A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.
" - }, - "ListTagsForResourcesResponse":{ - "type":"structure", - "required":["ResourceTagSets"], - "members":{ - "ResourceTagSets":{ - "shape":"ResourceTagSetList", - "documentation":"A list of ResourceTagSets containing tags associated with the specified resources.
A complex type containing tags for the specified resources.
" - }, - "NoSuchChange":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":404}, - "exception":true - }, - "NoSuchDelegationSet":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "exception":true, - "documentation":"The specified delegation set does not exist.
" - }, - "NoSuchGeoLocation":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The geo location you are trying to get does not exist.
" - }, - "NoSuchHealthCheck":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The health check you are trying to get or delete does not exist.
" - }, - "NoSuchHostedZone":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":404}, - "exception":true - }, - "Nonce":{ - "type":"string", - "min":1, - "max":128 - }, - "PageMarker":{ - "type":"string", - "max":64 - }, - "PageMaxItems":{"type":"string"}, - "PageTruncated":{"type":"boolean"}, - "Port":{ - "type":"integer", - "min":1, - "max":65535 - }, - "PriorRequestNotComplete":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request was rejected because Route 53 was still processing a prior request.
" - }, - "PublicZoneVPCAssociation":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The hosted zone you are trying to associate VPC with doesn't have any VPC association. Route 53 currently doesn't support associate a VPC with a public hosted zone.
" - }, - "RData":{ - "type":"string", - "max":4000 - }, - "RRType":{ - "type":"string", - "enum":[ - "SOA", - "A", - "TXT", - "NS", - "CNAME", - "MX", - "PTR", - "SRV", - "SPF", - "AAAA" - ] - }, - "RequestInterval":{ - "type":"integer", - "min":10, - "max":30 - }, - "ResourceDescription":{ - "type":"string", - "max":256 - }, - "ResourceId":{ - "type":"string", - "max":32 - }, - "ResourcePath":{ - "type":"string", - "max":255 - }, - "ResourceRecord":{ - "type":"structure", - "required":["Value"], - "members":{ - "Value":{ - "shape":"RData", - "documentation":"The value of the Value element for the current resource record set.
A complex type that contains the value of the Value element for the current resource record set.
The domain name of the current resource record set.
" - }, - "Type":{ - "shape":"RRType", - "documentation":"The type of the current resource record set.
" - }, - "SetIdentifier":{ - "shape":"ResourceRecordSetIdentifier", - "documentation":"Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
" - }, - "Weight":{ - "shape":"ResourceRecordSetWeight", - "documentation":"Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.
" - }, - "Region":{ - "shape":"ResourceRecordSetRegion", - "documentation":"Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
" - }, - "GeoLocation":{ - "shape":"GeoLocation", - "documentation":"Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
" - }, - "Failover":{ - "shape":"ResourceRecordSetFailover", - "documentation":"Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.
Valid values: PRIMARY | SECONDARY
The cache time to live for the current resource record set.
" - }, - "ResourceRecords":{ - "shape":"ResourceRecords", - "documentation":"A complex type that contains the resource records for the current resource record set.
" - }, - "AliasTarget":{ - "shape":"AliasTarget", - "documentation":"Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
" - }, - "HealthCheckId":{ - "shape":"HealthCheckId", - "documentation":"Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
" - } - }, - "documentation":"A complex type that contains information about the current resource record set.
" - }, - "ResourceRecordSetFailover":{ - "type":"string", - "enum":[ - "PRIMARY", - "SECONDARY" - ] - }, - "ResourceRecordSetIdentifier":{ - "type":"string", - "min":1, - "max":128 - }, - "ResourceRecordSetRegion":{ - "type":"string", - "enum":[ - "us-east-1", - "us-west-1", - "us-west-2", - "eu-west-1", - "eu-central-1", - "ap-southeast-1", - "ap-southeast-2", - "ap-northeast-1", - "sa-east-1", - "cn-north-1" - ], - "min":1, - "max":64 - }, - "ResourceRecordSetWeight":{ - "type":"long", - "min":0, - "max":255 - }, - "ResourceRecordSets":{ - "type":"list", - "member":{ - "shape":"ResourceRecordSet", - "locationName":"ResourceRecordSet" - } - }, - "ResourceRecords":{ - "type":"list", - "member":{ - "shape":"ResourceRecord", - "locationName":"ResourceRecord" - }, - "min":1 - }, - "ResourceTagSet":{ - "type":"structure", - "members":{ - "ResourceType":{ - "shape":"TagResourceType", - "documentation":"The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The ID for the specified resource.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The tags associated with the specified resource.
" - } - }, - "documentation":"A complex type containing a resource and its associated tags.
" - }, - "ResourceTagSetList":{ - "type":"list", - "member":{ - "shape":"ResourceTagSet", - "locationName":"ResourceTagSet" - } - }, - "ResourceURI":{ - "type":"string", - "max":1024 - }, - "SearchString":{ - "type":"string", - "max":255 - }, - "Status":{"type":"string"}, - "StatusReport":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"Status", - "documentation":"The observed health check status.
" - }, - "CheckedTime":{ - "shape":"TimeStamp", - "documentation":"The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
A complex type that contains information about the health check status for the current observation.
" - }, - "TTL":{ - "type":"long", - "min":0, - "max":2147483647 - }, - "Tag":{ - "type":"structure", - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"The key for a Tag.
The value for a Tag.
A single tag containing a key and value.
" - }, - "TagKey":{ - "type":"string", - "max":128 - }, - "TagKeyList":{ - "type":"list", - "member":{ - "shape":"TagKey", - "locationName":"Key" - }, - "min":1, - "max":10 - }, - "TagList":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"Tag" - }, - "min":1, - "max":10 - }, - "TagResourceId":{ - "type":"string", - "max":64 - }, - "TagResourceIdList":{ - "type":"list", - "member":{ - "shape":"TagResourceId", - "locationName":"ResourceId" - }, - "min":1, - "max":10 - }, - "TagResourceType":{ - "type":"string", - "enum":[ - "healthcheck", - "hostedzone" - ] - }, - "TagValue":{ - "type":"string", - "max":256 - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "TimeStamp":{"type":"timestamp"}, - "TooManyHealthChecks":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "exception":true - }, - "TooManyHostedZones":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
" - }, - "UpdateHealthCheckRequest":{ - "type":"structure", - "required":["HealthCheckId"], - "members":{ - "HealthCheckId":{ - "shape":"HealthCheckId", - "location":"uri", - "locationName":"HealthCheckId", - "documentation":"The ID of the health check to update.
" - }, - "HealthCheckVersion":{ - "shape":"HealthCheckVersion", - "documentation":"Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
" - }, - "Port":{ - "shape":"Port", - "documentation":"The port on which you want Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
" - }, - "ResourcePath":{ - "shape":"ResourcePath", - "documentation":"The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
" - }, - "FullyQualifiedDomainName":{ - "shape":"FullyQualifiedDomainName", - "documentation":"Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
" - }, - "SearchString":{ - "shape":"SearchString", - "documentation":"If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.
Specify this value only if you want to change it.
" - }, - "FailureThreshold":{ - "shape":"FailureThreshold", - "documentation":"The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
" - } - }, - "documentation":">A complex type that contains information about the request to update a health check.
" - }, - "UpdateHealthCheckResponse":{ - "type":"structure", - "required":["HealthCheck"], - "members":{ - "HealthCheck":{"shape":"HealthCheck"} - } - }, - "UpdateHostedZoneCommentRequest":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"ResourceId", - "location":"uri", - "locationName":"Id", - "documentation":"The ID of the hosted zone you want to update.
" - }, - "Comment":{ - "shape":"ResourceDescription", - "documentation":"A comment about your hosted zone.
" - } - }, - "documentation":"A complex type that contains information about the request to update a hosted zone comment.
" - }, - "UpdateHostedZoneCommentResponse":{ - "type":"structure", - "required":["HostedZone"], - "members":{ - "HostedZone":{"shape":"HostedZone"} - }, - "documentation":"A complex type containing information about the specified hosted zone after the update.
" - }, - "VPC":{ - "type":"structure", - "members":{ - "VPCRegion":{"shape":"VPCRegion"}, - "VPCId":{"shape":"VPCId"} - } - }, - "VPCAssociationNotFound":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"Descriptive message for the error response.
" - } - }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"The VPC you specified is not currently associated with the hosted zone.
" - }, - "VPCId":{ - "type":"string", - "max":1024, - "documentation":"A VPC ID
" - }, - "VPCRegion":{ - "type":"string", - "enum":[ - "us-east-1", - "us-west-1", - "us-west-2", - "eu-west-1", - "eu-central-1", - "ap-southeast-1", - "ap-southeast-2", - "ap-northeast-1", - "sa-east-1", - "cn-north-1" - ], - "min":1, - "max":64 - }, - "VPCs":{ - "type":"list", - "member":{ - "shape":"VPC", - "locationName":"VPC" - }, - "min":1, - "documentation":"A list of VPCs
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/route53/2013-04-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/route53/2013-04-01.paginators.json deleted file mode 100644 index d472f47a28..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/route53/2013-04-01.paginators.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "pagination": { - "ListHealthChecks": { - "input_token": "Marker", - "output_token": "NextMarker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "HealthChecks" - }, - "ListHostedZones": { - "input_token": "Marker", - "output_token": "NextMarker", - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "HostedZones" - }, - "ListResourceRecordSets": { - "more_results": "IsTruncated", - "limit_key": "MaxItems", - "result_key": "ResourceRecordSets", - "input_token": [ - "StartRecordName", - "StartRecordType", - "StartRecordIdentifier" - ], - "output_token": [ - "NextRecordName", - "NextRecordType", - "NextRecordIdentifier" - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/route53domains/2014-05-15.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/route53domains/2014-05-15.normal.json deleted file mode 100644 index 531145b084..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/route53domains/2014-05-15.normal.json +++ /dev/null @@ -1,1682 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2014-05-15", - "endpointPrefix":"route53domains", - "jsonVersion":"1.1", - "serviceFullName":"Amazon Route 53 Domains", - "signatureVersion":"v4", - "targetPrefix":"Route53Domains_v20140515", - "protocol":"json" - }, - "operations":{ - "CheckDomainAvailability":{ - "name":"CheckDomainAvailability", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CheckDomainAvailabilityRequest", - "documentation":"The CheckDomainAvailability request contains the following elements.
" - }, - "output":{ - "shape":"CheckDomainAvailabilityResponse", - "documentation":"The CheckDomainAvailability response includes the following elements.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"UnsupportedTLD", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Amazon Route 53 does not support this top-level domain.
" - } - ], - "documentation":"This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
" - }, - "DisableDomainAutoRenew":{ - "name":"DisableDomainAutoRenew", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableDomainAutoRenewRequest"}, - "output":{"shape":"DisableDomainAutoRenewResponse"}, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation disables automatic renewal of domain registration for the specified domain.
" - }, - "DisableDomainTransferLock":{ - "name":"DisableDomainTransferLock", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DisableDomainTransferLockRequest", - "documentation":"The DisableDomainTransferLock request includes the following element.
" - }, - "output":{ - "shape":"DisableDomainTransferLockResponse", - "documentation":"The DisableDomainTransferLock response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \"Renewal, restoration, and deletion times\" (http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times) on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.
" - }, - "EnableDomainTransferLock":{ - "name":"EnableDomainTransferLock", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"EnableDomainTransferLockRequest", - "documentation":"The EnableDomainTransferLock request includes the following element.
" - }, - "output":{ - "shape":"EnableDomainTransferLockResponse", - "documentation":"The EnableDomainTransferLock response includes the following elements.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
The GetDomainDetail request includes the following element.
" - }, - "output":{ - "shape":"GetDomainDetailResponse", - "documentation":"The GetDomainDetail response includes the following elements.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.
" - }, - "GetOperationDetail":{ - "name":"GetOperationDetail", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetOperationDetailRequest", - "documentation":"The GetOperationDetail request includes the following element.
" - }, - "output":{ - "shape":"GetOperationDetailResponse", - "documentation":"The GetOperationDetail response includes the following elements.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation returns the current status of an operation that is not completed.
" - }, - "ListDomains":{ - "name":"ListDomains", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListDomainsRequest", - "documentation":"The ListDomains request includes the following elements.
" - }, - "output":{ - "shape":"ListDomainsResponse", - "documentation":"The ListDomains response includes the following elements.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
" - }, - "ListOperations":{ - "name":"ListOperations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListOperationsRequest", - "documentation":"The ListOperations request includes the following elements.
" - }, - "output":{ - "shape":"ListOperationsResponse", - "documentation":"The ListOperations response includes the following elements.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation returns the operation IDs of operations that are not yet complete.
" - }, - "RegisterDomain":{ - "name":"RegisterDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RegisterDomainRequest", - "documentation":"The RegisterDomain request includes the following elements.
" - }, - "output":{ - "shape":"RegisterDomainResponse", - "documentation":"The RegisterDomain response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"UnsupportedTLD", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Amazon Route 53 does not support this top-level domain.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"DomainLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of domains has exceeded the allowed threshold for the account.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
The RetrieveDomainAuthCode request includes the following element.
" - }, - "output":{ - "shape":"RetrieveDomainAuthCodeResponse", - "documentation":"The RetrieveDomainAuthCode response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - } - ], - "documentation":"This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
" - }, - "TransferDomain":{ - "name":"TransferDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"TransferDomainRequest", - "documentation":"The TransferDomain request includes the following elements.
" - }, - "output":{ - "shape":"TransferDomainResponse", - "documentation":"The TranserDomain response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"UnsupportedTLD", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Amazon Route 53 does not support this top-level domain.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"DomainLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of domains has exceeded the allowed threshold for the account.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the AWS registrar, Gandi upon transfer.
To transfer a domain, you need to meet all the domain transfer criteria, including the following:
We recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted zone in Amazon Route 53 for your current domain before transferring your domain.
Note that upon transfer, the domain duration is extended for a year if not otherwise specified. Autorenew is enabled by default.
If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
Transferring domains charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
" - }, - "UpdateDomainContact":{ - "name":"UpdateDomainContact", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateDomainContactRequest", - "documentation":"The UpdateDomainContact request includes the following elements.
" - }, - "output":{ - "shape":"UpdateDomainContactResponse", - "documentation":"The UpdateDomainContact response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
" - }, - "UpdateDomainContactPrivacy":{ - "name":"UpdateDomainContactPrivacy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateDomainContactPrivacyRequest", - "documentation":"The UpdateDomainContactPrivacy request includes the following elements.
" - }, - "output":{ - "shape":"UpdateDomainContactPrivacyResponse", - "documentation":"The UpdateDomainContactPrivacy response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.
This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
" - }, - "UpdateDomainNameservers":{ - "name":"UpdateDomainNameservers", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateDomainNameserversRequest", - "documentation":"The UpdateDomainNameserver request includes the following elements.
" - }, - "output":{ - "shape":"UpdateDomainNameserversResponse", - "documentation":"The UpdateDomainNameservers response includes the following element.
" - }, - "errors":[ - { - "shape":"InvalidInput", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - { - "shape":"DuplicateRequest", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - { - "shape":"TLDRulesViolation", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - { - "shape":"OperationLimitExceeded", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - } - ], - "documentation":"This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
" - } - }, - "shapes":{ - "AddressLine":{ - "type":"string", - "max":255 - }, - "Boolean":{"type":"boolean"}, - "CheckDomainAvailabilityRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - }, - "IdnLangCode":{ - "shape":"LangCode", - "documentation":"Reserved for future use.
" - } - }, - "documentation":"The CheckDomainAvailability request contains the following elements.
" - }, - "CheckDomainAvailabilityResponse":{ - "type":"structure", - "required":["Availability"], - "members":{ - "Availability":{ - "shape":"DomainAvailability", - "documentation":"Whether the domain name is available for registering.
Type: String
Valid values:
AVAILABLE – The domain name is available.AVAILABLE_RESERVED – The domain name is reserved under specific conditions.AVAILABLE_PREORDER – The domain name is available and can be preordered.UNAVAILABLE – The domain name is not available.UNAVAILABLE_PREMIUM – The domain name is not available.UNAVAILABLE_RESTRICTED – The domain name is forbidden.RESERVED – The domain name has been reserved for another person or organization.The CheckDomainAvailability response includes the following elements.
" - }, - "City":{ - "type":"string", - "max":255 - }, - "ContactDetail":{ - "type":"structure", - "members":{ - "FirstName":{ - "shape":"ContactName", - "documentation":"First name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "LastName":{ - "shape":"ContactName", - "documentation":"Last name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "ContactType":{ - "shape":"ContactType", - "documentation":"Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "OrganizationName":{ - "shape":"ContactName", - "documentation":"Name of the organization for contact types other than PERSON.
Type: String
Default: None
Constraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" - }, - "AddressLine1":{ - "shape":"AddressLine", - "documentation":"First line of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "AddressLine2":{ - "shape":"AddressLine", - "documentation":"Second line of contact's address, if any.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" - }, - "City":{ - "shape":"City", - "documentation":"The city of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "State":{ - "shape":"State", - "documentation":"The state or province of the contact's city.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" - }, - "CountryCode":{ - "shape":"CountryCode", - "documentation":"Code for the country of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "ZipCode":{ - "shape":"ZipCode", - "documentation":"The zip or postal code of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" - }, - "PhoneNumber":{ - "shape":"ContactNumber", - "documentation":"The phone number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code>]\". For example, a US phone number might appear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "Email":{ - "shape":"Email", - "documentation":"Email address of the contact.
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" - }, - "Fax":{ - "shape":"ContactNumber", - "documentation":"Fax number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". For example, a US phone number might appear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" - }, - "ExtraParams":{ - "shape":"ExtraParamList", - "documentation":"A list of name-value pairs for parameters required by certain top-level domains.
Type: Complex
Default: None
Parents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
" - } - }, - "sensitive":true, - "documentation":"ContactDetail includes the following elements.
" - }, - "ContactName":{ - "type":"string", - "max":255 - }, - "ContactNumber":{ - "type":"string", - "max":30 - }, - "ContactType":{ - "type":"string", - "enum":[ - "PERSON", - "COMPANY", - "ASSOCIATION", - "PUBLIC_BODY", - "RESELLER" - ] - }, - "CountryCode":{ - "type":"string", - "enum":[ - "AD", - "AE", - "AF", - "AG", - "AI", - "AL", - "AM", - "AN", - "AO", - "AQ", - "AR", - "AS", - "AT", - "AU", - "AW", - "AZ", - "BA", - "BB", - "BD", - "BE", - "BF", - "BG", - "BH", - "BI", - "BJ", - "BL", - "BM", - "BN", - "BO", - "BR", - "BS", - "BT", - "BW", - "BY", - "BZ", - "CA", - "CC", - "CD", - "CF", - "CG", - "CH", - "CI", - "CK", - "CL", - "CM", - "CN", - "CO", - "CR", - "CU", - "CV", - "CX", - "CY", - "CZ", - "DE", - "DJ", - "DK", - "DM", - "DO", - "DZ", - "EC", - "EE", - "EG", - "ER", - "ES", - "ET", - "FI", - "FJ", - "FK", - "FM", - "FO", - "FR", - "GA", - "GB", - "GD", - "GE", - "GH", - "GI", - "GL", - "GM", - "GN", - "GQ", - "GR", - "GT", - "GU", - "GW", - "GY", - "HK", - "HN", - "HR", - "HT", - "HU", - "ID", - "IE", - "IL", - "IM", - "IN", - "IQ", - "IR", - "IS", - "IT", - "JM", - "JO", - "JP", - "KE", - "KG", - "KH", - "KI", - "KM", - "KN", - "KP", - "KR", - "KW", - "KY", - "KZ", - "LA", - "LB", - "LC", - "LI", - "LK", - "LR", - "LS", - "LT", - "LU", - "LV", - "LY", - "MA", - "MC", - "MD", - "ME", - "MF", - "MG", - "MH", - "MK", - "ML", - "MM", - "MN", - "MO", - "MP", - "MR", - "MS", - "MT", - "MU", - "MV", - "MW", - "MX", - "MY", - "MZ", - "NA", - "NC", - "NE", - "NG", - "NI", - "NL", - "NO", - "NP", - "NR", - "NU", - "NZ", - "OM", - "PA", - "PE", - "PF", - "PG", - "PH", - "PK", - "PL", - "PM", - "PN", - "PR", - "PT", - "PW", - "PY", - "QA", - "RO", - "RS", - "RU", - "RW", - "SA", - "SB", - "SC", - "SD", - "SE", - "SG", - "SH", - "SI", - "SK", - "SL", - "SM", - "SN", - "SO", - "SR", - "ST", - "SV", - "SY", - "SZ", - "TC", - "TD", - "TG", - "TH", - "TJ", - "TK", - "TL", - "TM", - "TN", - "TO", - "TR", - "TT", - "TV", - "TW", - "TZ", - "UA", - "UG", - "US", - "UY", - "UZ", - "VA", - "VC", - "VE", - "VG", - "VI", - "VN", - "VU", - "WF", - "WS", - "YE", - "YT", - "ZA", - "ZM", - "ZW" - ] - }, - "DNSSec":{"type":"string"}, - "DisableDomainAutoRenewRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{"shape":"DomainName"} - } - }, - "DisableDomainAutoRenewResponse":{ - "type":"structure", - "members":{ - } - }, - "DisableDomainTransferLockRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - } - }, - "documentation":"The DisableDomainTransferLock request includes the following element.
" - }, - "DisableDomainTransferLockResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The DisableDomainTransferLock response includes the following element.
" - }, - "DomainAuthCode":{ - "type":"string", - "max":1024, - "sensitive":true - }, - "DomainAvailability":{ - "type":"string", - "enum":[ - "AVAILABLE", - "AVAILABLE_RESERVED", - "AVAILABLE_PREORDER", - "UNAVAILABLE", - "UNAVAILABLE_PREMIUM", - "UNAVAILABLE_RESTRICTED", - "RESERVED" - ] - }, - "DomainLimitExceeded":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of domains has exceeded the allowed threshold for the account.
" - }, - "DomainName":{ - "type":"string", - "max":255, - "pattern":"[a-zA-Z0-9_\\-.]*" - }, - "DomainStatus":{"type":"string"}, - "DomainStatusList":{ - "type":"list", - "member":{"shape":"DomainStatus"} - }, - "DomainSummary":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
" - }, - "AutoRenew":{ - "shape":"Boolean", - "documentation":"Indicates whether the domain is automatically renewed upon expiration.
Type: Boolean
Valid values: True | False
Indicates whether a domain is locked from unauthorized transfer to another party.
Type: Boolean
Valid values: True | False
Expiration date of the domain in Coordinated Universal Time (UTC).
Type: Long
" - } - } - }, - "DomainSummaryList":{ - "type":"list", - "member":{"shape":"DomainSummary"} - }, - "DuplicateRequest":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The request is already in progress for the domain.
" - }, - "DurationInYears":{ - "type":"integer", - "min":1, - "max":10 - }, - "Email":{ - "type":"string", - "max":254 - }, - "EnableDomainAutoRenewRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{"shape":"DomainName"} - } - }, - "EnableDomainAutoRenewResponse":{ - "type":"structure", - "members":{ - } - }, - "EnableDomainTransferLockRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - } - }, - "documentation":"The EnableDomainTransferLock request includes the following element.
" - }, - "EnableDomainTransferLockResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The EnableDomainTransferLock response includes the following elements.
" - }, - "ErrorMessage":{"type":"string"}, - "ExtraParam":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"ExtraParamName", - "documentation":"Name of the additional parameter required by the top-level domain.
Type: String
Default: None
Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
" - }, - "Value":{ - "shape":"ExtraParamValue", - "documentation":"Values corresponding to the additional parameter names required by some top-level domains.
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent: ExtraParams
Required: Yes
" - } - }, - "documentation":"ExtraParam includes the following elements.
" - }, - "ExtraParamList":{ - "type":"list", - "member":{"shape":"ExtraParam"} - }, - "ExtraParamName":{ - "type":"string", - "enum":[ - "DUNS_NUMBER", - "BRAND_NUMBER", - "BIRTH_DEPARTMENT", - "BIRTH_DATE_IN_YYYY_MM_DD", - "BIRTH_COUNTRY", - "BIRTH_CITY", - "DOCUMENT_NUMBER", - "AU_ID_NUMBER", - "AU_ID_TYPE", - "CA_LEGAL_TYPE", - "FI_BUSINESS_NUMBER", - "FI_ID_NUMBER", - "IT_PIN", - "RU_PASSPORT_DATA", - "SE_ID_NUMBER", - "SG_ID_NUMBER", - "VAT_NUMBER" - ] - }, - "ExtraParamValue":{ - "type":"string", - "max":2048 - }, - "GetDomainDetailRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - } - }, - "documentation":"The GetDomainDetail request includes the following element.
" - }, - "GetDomainDetailResponse":{ - "type":"structure", - "required":[ - "DomainName", - "Nameservers", - "AdminContact", - "RegistrantContact", - "TechContact" - ], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
" - }, - "Nameservers":{ - "shape":"NameserverList", - "documentation":"The name of the domain.
Type: String
" - }, - "AutoRenew":{ - "shape":"Boolean", - "documentation":"Specifies whether the domain registration is set to renew automatically.
Type: Boolean
" - }, - "AdminContact":{ - "shape":"ContactDetail", - "documentation":"Provides details about the domain administrative contact.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Provides details about the domain registrant.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Provides details about the domain technical contact.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
" - }, - "RegistrantPrivacy":{ - "shape":"Boolean", - "documentation":"Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
" - }, - "TechPrivacy":{ - "shape":"Boolean", - "documentation":"Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
" - }, - "RegistrarName":{ - "shape":"RegistrarName", - "documentation":"Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is \"GANDI SAS\".
Type: String
" - }, - "WhoIsServer":{ - "shape":"RegistrarWhoIsServer", - "documentation":"The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
Type: String
" - }, - "RegistrarUrl":{ - "shape":"RegistrarUrl", - "documentation":"Web address of the registrar.
Type: String
" - }, - "AbuseContactEmail":{ - "shape":"Email", - "documentation":"Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
Type: String
" - }, - "AbuseContactPhone":{ - "shape":"ContactNumber", - "documentation":"Phone number for reporting abuse.
Type: String
" - }, - "RegistryDomainId":{ - "shape":"RegistryDomainId", - "documentation":"Reserved for future use.
" - }, - "CreationDate":{ - "shape":"Timestamp", - "documentation":"The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.
" - }, - "UpdatedDate":{ - "shape":"Timestamp", - "documentation":"The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
" - }, - "ExpirationDate":{ - "shape":"Timestamp", - "documentation":"The date when the registration for the domain is set to expire. The date format is Unix time.
" - }, - "Reseller":{ - "shape":"Reseller", - "documentation":"Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.
Type: String
" - }, - "DnsSec":{ - "shape":"DNSSec", - "documentation":"Reserved for future use.
" - }, - "StatusList":{ - "shape":"DomainStatusList", - "documentation":"An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)
Type: Array of String
" - } - }, - "documentation":"The GetDomainDetail response includes the following elements.
" - }, - "GetOperationDetailRequest":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.
Type: String
Default: None
Required: Yes
" - } - }, - "documentation":"The GetOperationDetail request includes the following element.
" - }, - "GetOperationDetailResponse":{ - "type":"structure", - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"The identifier for the operation.
Type: String
" - }, - "Status":{ - "shape":"OperationStatus", - "documentation":"The current status of the requested operation in the system.
Type: String
" - }, - "Message":{ - "shape":"ErrorMessage", - "documentation":"Detailed information on the status including possible errors.
Type: String
" - }, - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
" - }, - "Type":{ - "shape":"OperationType", - "documentation":"The type of operation that was requested.
Type: String
" - }, - "SubmittedDate":{ - "shape":"Timestamp", - "documentation":"The date when the request was submitted.
" - } - }, - "documentation":"The GetOperationDetail response includes the following elements.
" - }, - "GlueIp":{ - "type":"string", - "max":45 - }, - "GlueIpList":{ - "type":"list", - "member":{"shape":"GlueIp"} - }, - "HostName":{ - "type":"string", - "max":255, - "pattern":"[a-zA-Z0-9_\\-.]*" - }, - "InvalidInput":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
" - }, - "LangCode":{ - "type":"string", - "max":3 - }, - "ListDomainsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"PageMarker", - "documentation":"For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.
Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
" - }, - "MaxItems":{ - "shape":"PageMaxItems", - "documentation":"Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
" - } - }, - "documentation":"The ListDomains request includes the following elements.
" - }, - "ListDomainsResponse":{ - "type":"structure", - "required":["Domains"], - "members":{ - "Domains":{ - "shape":"DomainSummaryList", - "documentation":"A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew, DomainName, Expiry, TransferLock
If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.
Type: String
Parent: Operations
The ListDomains response includes the following elements.
" - }, - "ListOperationsRequest":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"PageMarker", - "documentation":"For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.
Type: String
Default: None
Required: No
" - }, - "MaxItems":{ - "shape":"PageMaxItems", - "documentation":"Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
" - } - }, - "documentation":"The ListOperations request includes the following elements.
" - }, - "ListOperationsResponse":{ - "type":"structure", - "required":["Operations"], - "members":{ - "Operations":{ - "shape":"OperationSummaryList", - "documentation":"Lists summaries of the operations.
Type: Complex type containing a list of operation summaries
Children: OperationId, Status, SubmittedDate, Type
If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.
Type: String
Parent: Operations
The ListOperations response includes the following elements.
" - }, - "Nameserver":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"HostName", - "documentation":"The fully qualified host name of the name server.
Type: String
Constraint: Maximum 255 characterss
Parent: Nameservers
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent: Nameservers
Nameserver includes the following elements.
" - }, - "NameserverList":{ - "type":"list", - "member":{"shape":"Nameserver"} - }, - "OperationId":{ - "type":"string", - "max":255 - }, - "OperationLimitExceeded":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The number of operations or jobs running exceeded the allowed threshold for the account.
" - }, - "OperationStatus":{ - "type":"string", - "enum":[ - "SUBMITTED", - "IN_PROGRESS", - "ERROR", - "SUCCESSFUL", - "FAILED" - ] - }, - "OperationSummary":{ - "type":"structure", - "required":[ - "OperationId", - "Status", - "Type", - "SubmittedDate" - ], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier returned to track the requested action.
Type: String
" - }, - "Status":{ - "shape":"OperationStatus", - "documentation":"The current status of the requested operation in the system.
Type: String
" - }, - "Type":{ - "shape":"OperationType", - "documentation":"Type of the action requested.
Type: String
Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK
The date when the request was submitted.
" - } - }, - "documentation":"OperationSummary includes the following elements.
" - }, - "OperationSummaryList":{ - "type":"list", - "member":{"shape":"OperationSummary"} - }, - "OperationType":{ - "type":"string", - "enum":[ - "REGISTER_DOMAIN", - "DELETE_DOMAIN", - "TRANSFER_IN_DOMAIN", - "UPDATE_DOMAIN_CONTACT", - "UPDATE_NAMESERVER", - "CHANGE_PRIVACY_PROTECTION", - "DOMAIN_LOCK" - ] - }, - "PageMarker":{ - "type":"string", - "max":4096 - }, - "PageMaxItems":{ - "type":"integer", - "max":100 - }, - "RegisterDomainRequest":{ - "type":"structure", - "required":[ - "DomainName", - "DurationInYears", - "AdminContact", - "RegistrantContact", - "TechContact" - ], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - }, - "IdnLangCode":{ - "shape":"LangCode", - "documentation":"Reserved for future use.
" - }, - "DurationInYears":{ - "shape":"DurationInYears", - "documentation":"The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
" - }, - "AutoRenew":{ - "shape":"Boolean", - "documentation":"Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
" - }, - "AdminContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "RegistrantContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "TechContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "PrivacyProtectAdminContact":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
" - }, - "PrivacyProtectRegistrantContact":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
" - }, - "PrivacyProtectTechContact":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
" - } - }, - "documentation":"The RegisterDomain request includes the following elements.
" - }, - "RegisterDomainResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The RegisterDomain response includes the following element.
" - }, - "RegistrarName":{"type":"string"}, - "RegistrarUrl":{"type":"string"}, - "RegistrarWhoIsServer":{"type":"string"}, - "RegistryDomainId":{"type":"string"}, - "Reseller":{"type":"string"}, - "RetrieveDomainAuthCodeRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - } - }, - "documentation":"The RetrieveDomainAuthCode request includes the following element.
" - }, - "RetrieveDomainAuthCodeResponse":{ - "type":"structure", - "required":["AuthCode"], - "members":{ - "AuthCode":{ - "shape":"DomainAuthCode", - "documentation":"The authorization code for the domain.
Type: String
" - } - }, - "documentation":"The RetrieveDomainAuthCode response includes the following element.
" - }, - "State":{ - "type":"string", - "max":255 - }, - "TLDRulesViolation":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The top-level domain does not support this operation.
" - }, - "Timestamp":{"type":"timestamp"}, - "TransferDomainRequest":{ - "type":"structure", - "required":[ - "DomainName", - "DurationInYears", - "Nameservers", - "AdminContact", - "RegistrantContact", - "TechContact" - ], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - }, - "IdnLangCode":{ - "shape":"LangCode", - "documentation":"Reserved for future use.
" - }, - "DurationInYears":{ - "shape":"DurationInYears", - "documentation":"The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
" - }, - "Nameservers":{ - "shape":"NameserverList", - "documentation":"Contains details for the host and glue IP addresses.
Type: Complex
Children: GlueIps, Name
The authorization code for the domain. You get this value from the current registrar.
Type: String
Required: Yes
" - }, - "AutoRenew":{ - "shape":"Boolean", - "documentation":"Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
" - }, - "AdminContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "RegistrantContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "TechContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "PrivacyProtectAdminContact":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
" - }, - "PrivacyProtectRegistrantContact":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
" - }, - "PrivacyProtectTechContact":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
" - } - }, - "documentation":"The TransferDomain request includes the following elements.
" - }, - "TransferDomainResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The TranserDomain response includes the following element.
" - }, - "UnsupportedTLD":{ - "type":"structure", - "members":{ - "message":{"shape":"ErrorMessage"} - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"Amazon Route 53 does not support this top-level domain.
" - }, - "UpdateDomainContactPrivacyRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - }, - "AdminPrivacy":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
" - }, - "RegistrantPrivacy":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
" - }, - "TechPrivacy":{ - "shape":"Boolean", - "documentation":"Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
" - } - }, - "documentation":"The UpdateDomainContactPrivacy request includes the following elements.
" - }, - "UpdateDomainContactPrivacyResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The UpdateDomainContactPrivacy response includes the following element.
" - }, - "UpdateDomainContactRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - }, - "AdminContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "RegistrantContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - }, - "TechContact":{ - "shape":"ContactDetail", - "documentation":"Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" - } - }, - "documentation":"The UpdateDomainContact request includes the following elements.
" - }, - "UpdateDomainContactResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The UpdateDomainContact response includes the following element.
" - }, - "UpdateDomainNameserversRequest":{ - "type":"structure", - "required":[ - "DomainName", - "Nameservers" - ], - "members":{ - "DomainName":{ - "shape":"DomainName", - "documentation":"The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
" - }, - "Nameservers":{ - "shape":"NameserverList", - "documentation":"A list of new name servers for the domain.
Type: Complex
Children: Name, GlueIps
Required: Yes
" - } - }, - "documentation":"The UpdateDomainNameserver request includes the following elements.
" - }, - "UpdateDomainNameserversResponse":{ - "type":"structure", - "required":["OperationId"], - "members":{ - "OperationId":{ - "shape":"OperationId", - "documentation":"Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" - } - }, - "documentation":"The UpdateDomainNameservers response includes the following element.
" - }, - "ZipCode":{ - "type":"string", - "max":255 - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.normal.json deleted file mode 100644 index 46944e4781..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.normal.json +++ /dev/null @@ -1,4332 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2006-03-01", - "checksumFormat":"md5", - "endpointPrefix":"s3", - "globalEndpoint":"s3.amazonaws.com", - "serviceAbbreviation":"Amazon S3", - "serviceFullName":"Amazon Simple Storage Service", - "signatureVersion":"s3", - "timestampFormat":"rfc822", - "protocol":"rest-xml" - }, - "operations":{ - "AbortMultipartUpload":{ - "name":"AbortMultipartUpload", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"AbortMultipartUploadRequest"}, - "errors":[ - { - "shape":"NoSuchUpload", - "exception":true, - "documentation":"The specified multipart upload does not exist." - } - ], - "documentation":"Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.
", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html" - }, - "CompleteMultipartUpload":{ - "name":"CompleteMultipartUpload", - "http":{ - "method":"POST", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"CompleteMultipartUploadRequest"}, - "output":{"shape":"CompleteMultipartUploadOutput"}, - "documentation":"Completes a multipart upload by assembling previously uploaded parts.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html" - }, - "CopyObject":{ - "name":"CopyObject", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"CopyObjectRequest"}, - "output":{"shape":"CopyObjectOutput"}, - "errors":[ - { - "shape":"ObjectNotInActiveTierError", - "exception":true, - "documentation":"The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier." - } - ], - "documentation":"Creates a copy of an object that is already stored in Amazon S3.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", - "alias":"PutObjectCopy" - }, - "CreateBucket":{ - "name":"CreateBucket", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}" - }, - "input":{"shape":"CreateBucketRequest"}, - "output":{"shape":"CreateBucketOutput"}, - "errors":[ - { - "shape":"BucketAlreadyExists", - "exception":true, - "documentation":"The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again." - } - ], - "documentation":"Creates a new bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", - "alias":"PutBucket" - }, - "CreateMultipartUpload":{ - "name":"CreateMultipartUpload", - "http":{ - "method":"POST", - "requestUri":"/{Bucket}/{Key+}?uploads" - }, - "input":{"shape":"CreateMultipartUploadRequest"}, - "output":{"shape":"CreateMultipartUploadOutput"}, - "documentation":"Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html", - "alias":"InitiateMultipartUpload" - }, - "DeleteBucket":{ - "name":"DeleteBucket", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}" - }, - "input":{"shape":"DeleteBucketRequest"}, - "documentation":"Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html" - }, - "DeleteBucketCors":{ - "name":"DeleteBucketCors", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}?cors" - }, - "input":{"shape":"DeleteBucketCorsRequest"}, - "documentation":"Deletes the cors configuration information set for the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html" - }, - "DeleteBucketLifecycle":{ - "name":"DeleteBucketLifecycle", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}?lifecycle" - }, - "input":{"shape":"DeleteBucketLifecycleRequest"}, - "documentation":"Deletes the lifecycle configuration from the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html" - }, - "DeleteBucketPolicy":{ - "name":"DeleteBucketPolicy", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}?policy" - }, - "input":{"shape":"DeleteBucketPolicyRequest"}, - "documentation":"Deletes the policy from the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html" - }, - "DeleteBucketTagging":{ - "name":"DeleteBucketTagging", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}?tagging" - }, - "input":{"shape":"DeleteBucketTaggingRequest"}, - "documentation":"Deletes the tags from the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html" - }, - "DeleteBucketWebsite":{ - "name":"DeleteBucketWebsite", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}?website" - }, - "input":{"shape":"DeleteBucketWebsiteRequest"}, - "documentation":"This operation removes the website configuration from the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html" - }, - "DeleteObject":{ - "name":"DeleteObject", - "http":{ - "method":"DELETE", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"DeleteObjectRequest"}, - "output":{"shape":"DeleteObjectOutput"}, - "documentation":"Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html" - }, - "DeleteObjects":{ - "name":"DeleteObjects", - "http":{ - "method":"POST", - "requestUri":"/{Bucket}?delete" - }, - "input":{"shape":"DeleteObjectsRequest"}, - "output":{"shape":"DeleteObjectsOutput"}, - "documentation":"This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html", - "alias":"DeleteMultipleObjects" - }, - "GetBucketAcl":{ - "name":"GetBucketAcl", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?acl" - }, - "input":{"shape":"GetBucketAclRequest"}, - "output":{"shape":"GetBucketAclOutput"}, - "documentation":"Gets the access control policy for the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html" - }, - "GetBucketCors":{ - "name":"GetBucketCors", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?cors" - }, - "input":{"shape":"GetBucketCorsRequest"}, - "output":{"shape":"GetBucketCorsOutput"}, - "documentation":"Returns the cors configuration for the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html" - }, - "GetBucketLifecycle":{ - "name":"GetBucketLifecycle", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?lifecycle" - }, - "input":{"shape":"GetBucketLifecycleRequest"}, - "output":{"shape":"GetBucketLifecycleOutput"}, - "documentation":"Returns the lifecycle configuration information set on the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html" - }, - "GetBucketLocation":{ - "name":"GetBucketLocation", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?location" - }, - "input":{"shape":"GetBucketLocationRequest"}, - "output":{"shape":"GetBucketLocationOutput"}, - "documentation":"Returns the region the bucket resides in.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html" - }, - "GetBucketLogging":{ - "name":"GetBucketLogging", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?logging" - }, - "input":{"shape":"GetBucketLoggingRequest"}, - "output":{"shape":"GetBucketLoggingOutput"}, - "documentation":"Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html" - }, - "GetBucketNotification":{ - "name":"GetBucketNotification", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?notification" - }, - "input":{"shape":"GetBucketNotificationRequest"}, - "output":{"shape":"GetBucketNotificationOutput"}, - "documentation":"Return the notification configuration of a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html" - }, - "GetBucketPolicy":{ - "name":"GetBucketPolicy", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?policy" - }, - "input":{"shape":"GetBucketPolicyRequest"}, - "output":{"shape":"GetBucketPolicyOutput"}, - "documentation":"Returns the policy of a specified bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html" - }, - "GetBucketRequestPayment":{ - "name":"GetBucketRequestPayment", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?requestPayment" - }, - "input":{"shape":"GetBucketRequestPaymentRequest"}, - "output":{"shape":"GetBucketRequestPaymentOutput"}, - "documentation":"Returns the request payment configuration of a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html" - }, - "GetBucketTagging":{ - "name":"GetBucketTagging", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?tagging" - }, - "input":{"shape":"GetBucketTaggingRequest"}, - "output":{"shape":"GetBucketTaggingOutput"}, - "documentation":"Returns the tag set associated with the bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html" - }, - "GetBucketVersioning":{ - "name":"GetBucketVersioning", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?versioning" - }, - "input":{"shape":"GetBucketVersioningRequest"}, - "output":{"shape":"GetBucketVersioningOutput"}, - "documentation":"Returns the versioning state of a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html" - }, - "GetBucketWebsite":{ - "name":"GetBucketWebsite", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?website" - }, - "input":{"shape":"GetBucketWebsiteRequest"}, - "output":{"shape":"GetBucketWebsiteOutput"}, - "documentation":"Returns the website configuration for a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html" - }, - "GetObject":{ - "name":"GetObject", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"GetObjectRequest"}, - "output":{"shape":"GetObjectOutput"}, - "errors":[ - { - "shape":"NoSuchKey", - "exception":true, - "documentation":"The specified key does not exist." - } - ], - "documentation":"Retrieves objects from Amazon S3.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html" - }, - "GetObjectAcl":{ - "name":"GetObjectAcl", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}/{Key+}?acl" - }, - "input":{"shape":"GetObjectAclRequest"}, - "output":{"shape":"GetObjectAclOutput"}, - "errors":[ - { - "shape":"NoSuchKey", - "exception":true, - "documentation":"The specified key does not exist." - } - ], - "documentation":"Returns the access control list (ACL) of an object.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html" - }, - "GetObjectTorrent":{ - "name":"GetObjectTorrent", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}/{Key+}?torrent" - }, - "input":{"shape":"GetObjectTorrentRequest"}, - "output":{"shape":"GetObjectTorrentOutput"}, - "documentation":"Return torrent files from a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html" - }, - "HeadBucket":{ - "name":"HeadBucket", - "http":{ - "method":"HEAD", - "requestUri":"/{Bucket}" - }, - "input":{"shape":"HeadBucketRequest"}, - "errors":[ - { - "shape":"NoSuchBucket", - "exception":true, - "documentation":"The specified bucket does not exist." - } - ], - "documentation":"This operation is useful to determine if a bucket exists and you have permission to access it.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html" - }, - "HeadObject":{ - "name":"HeadObject", - "http":{ - "method":"HEAD", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"HeadObjectRequest"}, - "output":{"shape":"HeadObjectOutput"}, - "errors":[ - { - "shape":"NoSuchKey", - "exception":true, - "documentation":"The specified key does not exist." - } - ], - "documentation":"The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html" - }, - "ListBuckets":{ - "name":"ListBuckets", - "http":{ - "method":"GET", - "requestUri":"/" - }, - "output":{"shape":"ListBucketsOutput"}, - "documentation":"Returns a list of all buckets owned by the authenticated sender of the request.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html", - "alias":"GetService" - }, - "ListMultipartUploads":{ - "name":"ListMultipartUploads", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?uploads" - }, - "input":{"shape":"ListMultipartUploadsRequest"}, - "output":{"shape":"ListMultipartUploadsOutput"}, - "documentation":"This operation lists in-progress multipart uploads.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html" - }, - "ListObjectVersions":{ - "name":"ListObjectVersions", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}?versions" - }, - "input":{"shape":"ListObjectVersionsRequest"}, - "output":{"shape":"ListObjectVersionsOutput"}, - "documentation":"Returns metadata about all of the versions of objects in a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html", - "alias":"GetBucketObjectVersions" - }, - "ListObjects":{ - "name":"ListObjects", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}" - }, - "input":{"shape":"ListObjectsRequest"}, - "output":{"shape":"ListObjectsOutput"}, - "errors":[ - { - "shape":"NoSuchBucket", - "exception":true, - "documentation":"The specified bucket does not exist." - } - ], - "documentation":"Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html", - "alias":"GetBucket" - }, - "ListParts":{ - "name":"ListParts", - "http":{ - "method":"GET", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"ListPartsRequest"}, - "output":{"shape":"ListPartsOutput"}, - "documentation":"Lists the parts that have been uploaded for a specific multipart upload.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html" - }, - "PutBucketAcl":{ - "name":"PutBucketAcl", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?acl" - }, - "input":{"shape":"PutBucketAclRequest"}, - "documentation":"Sets the permissions on a bucket using access control lists (ACL).", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html" - }, - "PutBucketCors":{ - "name":"PutBucketCors", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?cors" - }, - "input":{"shape":"PutBucketCorsRequest"}, - "documentation":"Sets the cors configuration for a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html" - }, - "PutBucketLifecycle":{ - "name":"PutBucketLifecycle", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?lifecycle" - }, - "input":{"shape":"PutBucketLifecycleRequest"}, - "documentation":"Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html" - }, - "PutBucketLogging":{ - "name":"PutBucketLogging", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?logging" - }, - "input":{"shape":"PutBucketLoggingRequest"}, - "documentation":"Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html" - }, - "PutBucketNotification":{ - "name":"PutBucketNotification", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?notification" - }, - "input":{"shape":"PutBucketNotificationRequest"}, - "documentation":"Enables notifications of specified events for a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html" - }, - "PutBucketPolicy":{ - "name":"PutBucketPolicy", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?policy" - }, - "input":{"shape":"PutBucketPolicyRequest"}, - "documentation":"Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html" - }, - "PutBucketRequestPayment":{ - "name":"PutBucketRequestPayment", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?requestPayment" - }, - "input":{"shape":"PutBucketRequestPaymentRequest"}, - "documentation":"Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html" - }, - "PutBucketTagging":{ - "name":"PutBucketTagging", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?tagging" - }, - "input":{"shape":"PutBucketTaggingRequest"}, - "documentation":"Sets the tags for a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html" - }, - "PutBucketVersioning":{ - "name":"PutBucketVersioning", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?versioning" - }, - "input":{"shape":"PutBucketVersioningRequest"}, - "documentation":"Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html" - }, - "PutBucketWebsite":{ - "name":"PutBucketWebsite", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}?website" - }, - "input":{"shape":"PutBucketWebsiteRequest"}, - "documentation":"Set the website configuration for a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html" - }, - "PutObject":{ - "name":"PutObject", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"PutObjectRequest"}, - "output":{"shape":"PutObjectOutput"}, - "documentation":"Adds an object to a bucket.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html" - }, - "PutObjectAcl":{ - "name":"PutObjectAcl", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}/{Key+}?acl" - }, - "input":{"shape":"PutObjectAclRequest"}, - "errors":[ - { - "shape":"NoSuchKey", - "exception":true, - "documentation":"The specified key does not exist." - } - ], - "documentation":"uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html" - }, - "RestoreObject":{ - "name":"RestoreObject", - "http":{ - "method":"POST", - "requestUri":"/{Bucket}/{Key+}?restore" - }, - "input":{"shape":"RestoreObjectRequest"}, - "errors":[ - { - "shape":"ObjectAlreadyInActiveTierError", - "exception":true, - "documentation":"This operation is not allowed against this storage tier" - } - ], - "documentation":"Restores an archived copy of an object back into Amazon S3", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html", - "alias":"PostObjectRestore" - }, - "UploadPart":{ - "name":"UploadPart", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"UploadPartRequest"}, - "output":{"shape":"UploadPartOutput"}, - "documentation":"Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html" - }, - "UploadPartCopy":{ - "name":"UploadPartCopy", - "http":{ - "method":"PUT", - "requestUri":"/{Bucket}/{Key+}" - }, - "input":{"shape":"UploadPartCopyRequest"}, - "output":{"shape":"UploadPartCopyOutput"}, - "documentation":"Uploads a part by copying data from an existing object as data source.", - "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html" - } - }, - "shapes":{ - "AbortMultipartUploadRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key", - "UploadId" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "UploadId":{ - "shape":"MultipartUploadId", - "location":"querystring", - "locationName":"uploadId" - } - } - }, - "AcceptRanges":{"type":"string"}, - "AccessControlPolicy":{ - "type":"structure", - "members":{ - "Grants":{ - "shape":"Grants", - "documentation":"A list of grants.", - "locationName":"AccessControlList" - }, - "Owner":{"shape":"Owner"} - } - }, - "AllowedHeader":{"type":"string"}, - "AllowedHeaders":{ - "type":"list", - "member":{"shape":"AllowedHeader"}, - "flattened":true - }, - "AllowedMethod":{"type":"string"}, - "AllowedMethods":{ - "type":"list", - "member":{"shape":"AllowedMethod"}, - "flattened":true - }, - "AllowedOrigin":{"type":"string"}, - "AllowedOrigins":{ - "type":"list", - "member":{"shape":"AllowedOrigin"}, - "flattened":true - }, - "Body":{"type":"blob"}, - "Bucket":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"BucketName", - "documentation":"The name of the bucket." - }, - "CreationDate":{ - "shape":"CreationDate", - "documentation":"Date the bucket was created." - } - } - }, - "BucketAlreadyExists":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again." - }, - "BucketCannedACL":{ - "type":"string", - "enum":[ - "private", - "public-read", - "public-read-write", - "authenticated-read" - ] - }, - "BucketLocationConstraint":{ - "type":"string", - "enum":[ - "EU", - "eu-west-1", - "us-west-1", - "us-west-2", - "ap-southeast-1", - "ap-southeast-2", - "ap-northeast-1", - "sa-east-1", - "", - "cn-north-1", - "eu-central-1" - ] - }, - "BucketLoggingStatus":{ - "type":"structure", - "members":{ - "LoggingEnabled":{"shape":"LoggingEnabled"} - } - }, - "BucketLogsPermission":{ - "type":"string", - "enum":[ - "FULL_CONTROL", - "READ", - "WRITE" - ] - }, - "BucketName":{"type":"string"}, - "BucketVersioningStatus":{ - "type":"string", - "enum":[ - "Enabled", - "Suspended" - ] - }, - "Buckets":{ - "type":"list", - "member":{ - "shape":"Bucket", - "locationName":"Bucket" - } - }, - "CORSConfiguration":{ - "type":"structure", - "members":{ - "CORSRules":{ - "shape":"CORSRules", - "locationName":"CORSRule" - } - } - }, - "CORSRule":{ - "type":"structure", - "members":{ - "AllowedHeaders":{ - "shape":"AllowedHeaders", - "documentation":"Specifies which headers are allowed in a pre-flight OPTIONS request.", - "locationName":"AllowedHeader" - }, - "AllowedMethods":{ - "shape":"AllowedMethods", - "documentation":"Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.", - "locationName":"AllowedMethod" - }, - "AllowedOrigins":{ - "shape":"AllowedOrigins", - "documentation":"One or more origins you want customers to be able to access the bucket from.", - "locationName":"AllowedOrigin" - }, - "ExposeHeaders":{ - "shape":"ExposeHeaders", - "documentation":"One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).", - "locationName":"ExposeHeader" - }, - "MaxAgeSeconds":{ - "shape":"MaxAgeSeconds", - "documentation":"The time in seconds that your browser is to cache the preflight response for the specified resource." - } - } - }, - "CORSRules":{ - "type":"list", - "member":{"shape":"CORSRule"}, - "flattened":true - }, - "CacheControl":{"type":"string"}, - "CloudFunction":{"type":"string"}, - "CloudFunctionConfiguration":{ - "type":"structure", - "members":{ - "Id":{"shape":"NotificationId"}, - "Event":{ - "shape":"Event", - "deprecated":true - }, - "Events":{ - "shape":"Events", - "locationName":"Event" - }, - "CloudFunction":{"shape":"CloudFunction"}, - "InvocationRole":{"shape":"CloudFunctionInvocationRole"} - } - }, - "CloudFunctionInvocationRole":{"type":"string"}, - "Code":{"type":"string"}, - "CommonPrefix":{ - "type":"structure", - "members":{ - "Prefix":{"shape":"Prefix"} - } - }, - "CommonPrefixList":{ - "type":"list", - "member":{"shape":"CommonPrefix"}, - "flattened":true - }, - "CompleteMultipartUploadOutput":{ - "type":"structure", - "members":{ - "Location":{"shape":"Location"}, - "Bucket":{"shape":"BucketName"}, - "Key":{"shape":"ObjectKey"}, - "Expiration":{ - "shape":"Expiration", - "location":"header", - "locationName":"x-amz-expiration", - "documentation":"If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." - }, - "ETag":{ - "shape":"ETag", - "documentation":"Entity tag of the object." - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"header", - "locationName":"x-amz-version-id", - "documentation":"Version of the object." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - } - }, - "CompleteMultipartUploadRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key", - "UploadId" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "MultipartUpload":{ - "shape":"CompletedMultipartUpload", - "locationName":"CompleteMultipartUpload", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} - }, - "UploadId":{ - "shape":"MultipartUploadId", - "location":"querystring", - "locationName":"uploadId" - } - }, - "payload":"MultipartUpload" - }, - "CompletedMultipartUpload":{ - "type":"structure", - "members":{ - "Parts":{ - "shape":"CompletedPartList", - "locationName":"Part" - } - } - }, - "CompletedPart":{ - "type":"structure", - "members":{ - "ETag":{ - "shape":"ETag", - "documentation":"Entity tag returned when the part was uploaded." - }, - "PartNumber":{ - "shape":"PartNumber", - "documentation":"Part number that identifies the part." - } - } - }, - "CompletedPartList":{ - "type":"list", - "member":{"shape":"CompletedPart"}, - "flattened":true - }, - "Condition":{ - "type":"structure", - "members":{ - "HttpErrorCodeReturnedEquals":{ - "shape":"HttpErrorCodeReturnedEquals", - "documentation":"The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied." - }, - "KeyPrefixEquals":{ - "shape":"KeyPrefixEquals", - "documentation":"The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied." - } - } - }, - "ContentDisposition":{"type":"string"}, - "ContentEncoding":{"type":"string"}, - "ContentLanguage":{"type":"string"}, - "ContentLength":{"type":"integer"}, - "ContentMD5":{"type":"string"}, - "ContentType":{"type":"string"}, - "CopyObjectOutput":{ - "type":"structure", - "members":{ - "CopyObjectResult":{"shape":"CopyObjectResult"}, - "Expiration":{ - "shape":"Expiration", - "location":"header", - "locationName":"x-amz-expiration", - "documentation":"If the object expiration is configured, the response includes this header." - }, - "CopySourceVersionId":{ - "shape":"CopySourceVersionId", - "location":"header", - "locationName":"x-amz-copy-source-version-id" - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - }, - "payload":"CopyObjectResult" - }, - "CopyObjectRequest":{ - "type":"structure", - "required":[ - "Bucket", - "CopySource", - "Key" - ], - "members":{ - "ACL":{ - "shape":"ObjectCannedACL", - "location":"header", - "locationName":"x-amz-acl", - "documentation":"The canned ACL to apply to the object." - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "CacheControl":{ - "shape":"CacheControl", - "location":"header", - "locationName":"Cache-Control", - "documentation":"Specifies caching behavior along the request/reply chain." - }, - "ContentDisposition":{ - "shape":"ContentDisposition", - "location":"header", - "locationName":"Content-Disposition", - "documentation":"Specifies presentational information for the object." - }, - "ContentEncoding":{ - "shape":"ContentEncoding", - "location":"header", - "locationName":"Content-Encoding", - "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." - }, - "ContentLanguage":{ - "shape":"ContentLanguage", - "location":"header", - "locationName":"Content-Language", - "documentation":"The language the content is in." - }, - "ContentType":{ - "shape":"ContentType", - "location":"header", - "locationName":"Content-Type", - "documentation":"A standard MIME type describing the format of the object data." - }, - "CopySource":{ - "shape":"CopySource", - "location":"header", - "locationName":"x-amz-copy-source", - "documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded." - }, - "CopySourceIfMatch":{ - "shape":"CopySourceIfMatch", - "location":"header", - "locationName":"x-amz-copy-source-if-match", - "documentation":"Copies the object if its entity tag (ETag) matches the specified tag." - }, - "CopySourceIfModifiedSince":{ - "shape":"CopySourceIfModifiedSince", - "location":"header", - "locationName":"x-amz-copy-source-if-modified-since", - "documentation":"Copies the object if it has been modified since the specified time." - }, - "CopySourceIfNoneMatch":{ - "shape":"CopySourceIfNoneMatch", - "location":"header", - "locationName":"x-amz-copy-source-if-none-match", - "documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag." - }, - "CopySourceIfUnmodifiedSince":{ - "shape":"CopySourceIfUnmodifiedSince", - "location":"header", - "locationName":"x-amz-copy-source-if-unmodified-since", - "documentation":"Copies the object if it hasn't been modified since the specified time." - }, - "Expires":{ - "shape":"Expires", - "location":"header", - "locationName":"Expires", - "documentation":"The date and time at which the object is no longer cacheable." - }, - "GrantFullControl":{ - "shape":"GrantFullControl", - "location":"header", - "locationName":"x-amz-grant-full-control", - "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." - }, - "GrantRead":{ - "shape":"GrantRead", - "location":"header", - "locationName":"x-amz-grant-read", - "documentation":"Allows grantee to read the object data and its metadata." - }, - "GrantReadACP":{ - "shape":"GrantReadACP", - "location":"header", - "locationName":"x-amz-grant-read-acp", - "documentation":"Allows grantee to read the object ACL." - }, - "GrantWriteACP":{ - "shape":"GrantWriteACP", - "location":"header", - "locationName":"x-amz-grant-write-acp", - "documentation":"Allows grantee to write the ACL for the applicable object." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "Metadata":{ - "shape":"Metadata", - "location":"headers", - "documentation":"A map of metadata to store with the object in S3.", - "locationName":"x-amz-meta-" - }, - "MetadataDirective":{ - "shape":"MetadataDirective", - "location":"header", - "locationName":"x-amz-metadata-directive", - "documentation":"Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request." - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "StorageClass":{ - "shape":"StorageClass", - "location":"header", - "locationName":"x-amz-storage-class", - "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'." - }, - "WebsiteRedirectLocation":{ - "shape":"WebsiteRedirectLocation", - "location":"header", - "locationName":"x-amz-website-redirect-location", - "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version" - }, - "CopySourceSSECustomerAlgorithm":{ - "shape":"CopySourceSSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256)." - }, - "CopySourceSSECustomerKey":{ - "shape":"CopySourceSSECustomerKey", - "location":"header", - "locationName":"x-amz-copy-source-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created." - }, - "CopySourceSSECustomerKeyMD5":{ - "shape":"CopySourceSSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - } - } - }, - "CopyObjectResult":{ - "type":"structure", - "members":{ - "ETag":{"shape":"ETag"}, - "LastModified":{"shape":"LastModified"} - } - }, - "CopyPartResult":{ - "type":"structure", - "members":{ - "ETag":{ - "shape":"ETag", - "documentation":"Entity tag of the object." - }, - "LastModified":{ - "shape":"LastModified", - "documentation":"Date and time at which the object was uploaded." - } - } - }, - "CopySource":{ - "type":"string", - "pattern":"\\/.+\\/.+" - }, - "CopySourceIfMatch":{"type":"string"}, - "CopySourceIfModifiedSince":{"type":"timestamp"}, - "CopySourceIfNoneMatch":{"type":"string"}, - "CopySourceIfUnmodifiedSince":{"type":"timestamp"}, - "CopySourceRange":{"type":"string"}, - "CopySourceSSECustomerAlgorithm":{"type":"string"}, - "CopySourceSSECustomerKey":{ - "type":"string", - "sensitive":true - }, - "CopySourceSSECustomerKeyMD5":{"type":"string"}, - "CopySourceVersionId":{"type":"string"}, - "CreateBucketConfiguration":{ - "type":"structure", - "members":{ - "LocationConstraint":{ - "shape":"BucketLocationConstraint", - "documentation":"Specifies the region where the bucket will be created." - } - } - }, - "CreateBucketOutput":{ - "type":"structure", - "members":{ - "Location":{ - "shape":"Location", - "location":"header", - "locationName":"Location" - } - } - }, - "CreateBucketRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "ACL":{ - "shape":"BucketCannedACL", - "location":"header", - "locationName":"x-amz-acl", - "documentation":"The canned ACL to apply to the bucket." - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "CreateBucketConfiguration":{ - "shape":"CreateBucketConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"CreateBucketConfiguration" - }, - "GrantFullControl":{ - "shape":"GrantFullControl", - "location":"header", - "locationName":"x-amz-grant-full-control", - "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." - }, - "GrantRead":{ - "shape":"GrantRead", - "location":"header", - "locationName":"x-amz-grant-read", - "documentation":"Allows grantee to list the objects in the bucket." - }, - "GrantReadACP":{ - "shape":"GrantReadACP", - "location":"header", - "locationName":"x-amz-grant-read-acp", - "documentation":"Allows grantee to read the bucket ACL." - }, - "GrantWrite":{ - "shape":"GrantWrite", - "location":"header", - "locationName":"x-amz-grant-write", - "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket." - }, - "GrantWriteACP":{ - "shape":"GrantWriteACP", - "location":"header", - "locationName":"x-amz-grant-write-acp", - "documentation":"Allows grantee to write the ACL for the applicable bucket." - } - }, - "payload":"CreateBucketConfiguration" - }, - "CreateMultipartUploadOutput":{ - "type":"structure", - "members":{ - "Bucket":{ - "shape":"BucketName", - "documentation":"Name of the bucket to which the multipart upload was initiated.", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "documentation":"Object key for which the multipart upload was initiated." - }, - "UploadId":{ - "shape":"MultipartUploadId", - "documentation":"ID for the initiated multipart upload." - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - } - }, - "CreateMultipartUploadRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "ACL":{ - "shape":"ObjectCannedACL", - "location":"header", - "locationName":"x-amz-acl", - "documentation":"The canned ACL to apply to the object." - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "CacheControl":{ - "shape":"CacheControl", - "location":"header", - "locationName":"Cache-Control", - "documentation":"Specifies caching behavior along the request/reply chain." - }, - "ContentDisposition":{ - "shape":"ContentDisposition", - "location":"header", - "locationName":"Content-Disposition", - "documentation":"Specifies presentational information for the object." - }, - "ContentEncoding":{ - "shape":"ContentEncoding", - "location":"header", - "locationName":"Content-Encoding", - "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." - }, - "ContentLanguage":{ - "shape":"ContentLanguage", - "location":"header", - "locationName":"Content-Language", - "documentation":"The language the content is in." - }, - "ContentType":{ - "shape":"ContentType", - "location":"header", - "locationName":"Content-Type", - "documentation":"A standard MIME type describing the format of the object data." - }, - "Expires":{ - "shape":"Expires", - "location":"header", - "locationName":"Expires", - "documentation":"The date and time at which the object is no longer cacheable." - }, - "GrantFullControl":{ - "shape":"GrantFullControl", - "location":"header", - "locationName":"x-amz-grant-full-control", - "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." - }, - "GrantRead":{ - "shape":"GrantRead", - "location":"header", - "locationName":"x-amz-grant-read", - "documentation":"Allows grantee to read the object data and its metadata." - }, - "GrantReadACP":{ - "shape":"GrantReadACP", - "location":"header", - "locationName":"x-amz-grant-read-acp", - "documentation":"Allows grantee to read the object ACL." - }, - "GrantWriteACP":{ - "shape":"GrantWriteACP", - "location":"header", - "locationName":"x-amz-grant-write-acp", - "documentation":"Allows grantee to write the ACL for the applicable object." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "Metadata":{ - "shape":"Metadata", - "location":"headers", - "documentation":"A map of metadata to store with the object in S3.", - "locationName":"x-amz-meta-" - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "StorageClass":{ - "shape":"StorageClass", - "location":"header", - "locationName":"x-amz-storage-class", - "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'." - }, - "WebsiteRedirectLocation":{ - "shape":"WebsiteRedirectLocation", - "location":"header", - "locationName":"x-amz-website-redirect-location", - "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version" - } - } - }, - "CreationDate":{"type":"timestamp"}, - "Date":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "Days":{"type":"integer"}, - "Delete":{ - "type":"structure", - "required":["Objects"], - "members":{ - "Objects":{ - "shape":"ObjectIdentifierList", - "locationName":"Object" - }, - "Quiet":{ - "shape":"Quiet", - "documentation":"Element to enable quiet mode for the request. When you add this element, you must set its value to true." - } - } - }, - "DeleteBucketCorsRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "DeleteBucketLifecycleRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "DeleteBucketPolicyRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "DeleteBucketRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "DeleteBucketTaggingRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "DeleteBucketWebsiteRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "DeleteMarker":{"type":"boolean"}, - "DeleteMarkerEntry":{ - "type":"structure", - "members":{ - "Owner":{"shape":"Owner"}, - "Key":{ - "shape":"ObjectKey", - "documentation":"The object key." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "documentation":"Version ID of an object." - }, - "IsLatest":{ - "shape":"IsLatest", - "documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object." - }, - "LastModified":{ - "shape":"LastModified", - "documentation":"Date and time the object was last modified." - } - } - }, - "DeleteMarkerVersionId":{"type":"string"}, - "DeleteMarkers":{ - "type":"list", - "member":{"shape":"DeleteMarkerEntry"}, - "flattened":true - }, - "DeleteObjectOutput":{ - "type":"structure", - "members":{ - "DeleteMarker":{ - "shape":"DeleteMarker", - "location":"header", - "locationName":"x-amz-delete-marker", - "documentation":"Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"header", - "locationName":"x-amz-version-id", - "documentation":"Returns the version ID of the delete marker created as a result of the DELETE operation." - } - } - }, - "DeleteObjectRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "MFA":{ - "shape":"MFA", - "location":"header", - "locationName":"x-amz-mfa", - "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"querystring", - "locationName":"versionId", - "documentation":"VersionId used to reference a specific version of the object." - } - } - }, - "DeleteObjectsOutput":{ - "type":"structure", - "members":{ - "Deleted":{"shape":"DeletedObjects"}, - "Errors":{ - "shape":"Errors", - "locationName":"Error" - } - } - }, - "DeleteObjectsRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Delete" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Delete":{ - "shape":"Delete", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"Delete" - }, - "MFA":{ - "shape":"MFA", - "location":"header", - "locationName":"x-amz-mfa", - "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." - } - }, - "payload":"Delete" - }, - "DeletedObject":{ - "type":"structure", - "members":{ - "Key":{"shape":"ObjectKey"}, - "VersionId":{"shape":"ObjectVersionId"}, - "DeleteMarker":{"shape":"DeleteMarker"}, - "DeleteMarkerVersionId":{"shape":"DeleteMarkerVersionId"} - } - }, - "DeletedObjects":{ - "type":"list", - "member":{"shape":"DeletedObject"}, - "flattened":true - }, - "Delimiter":{"type":"string"}, - "DisplayName":{"type":"string"}, - "ETag":{"type":"string"}, - "EmailAddress":{"type":"string"}, - "EncodingType":{ - "type":"string", - "enum":["url"], - "documentation":"Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response." - }, - "Error":{ - "type":"structure", - "members":{ - "Key":{"shape":"ObjectKey"}, - "VersionId":{"shape":"ObjectVersionId"}, - "Code":{"shape":"Code"}, - "Message":{"shape":"Message"} - } - }, - "ErrorDocument":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"ObjectKey", - "documentation":"The object key name to use when a 4XX class error occurs." - } - } - }, - "Errors":{ - "type":"list", - "member":{"shape":"Error"}, - "flattened":true - }, - "Event":{ - "type":"string", - "enum":[ - "s3:ReducedRedundancyLostObject", - "s3:ObjectCreated:Put", - "s3:ObjectCreated:Post", - "s3:ObjectCreated:Copy", - "s3:ObjectCreated:CompleteMultipartUpload" - ] - }, - "Events":{ - "type":"list", - "member":{"shape":"Event"}, - "flattened":true - }, - "Expiration":{"type":"string"}, - "ExpirationStatus":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "Expires":{"type":"timestamp"}, - "ExposeHeader":{"type":"string"}, - "ExposeHeaders":{ - "type":"list", - "member":{"shape":"ExposeHeader"}, - "flattened":true - }, - "GetBucketAclOutput":{ - "type":"structure", - "members":{ - "Owner":{"shape":"Owner"}, - "Grants":{ - "shape":"Grants", - "documentation":"A list of grants.", - "locationName":"AccessControlList" - } - } - }, - "GetBucketAclRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketCorsOutput":{ - "type":"structure", - "members":{ - "CORSRules":{ - "shape":"CORSRules", - "locationName":"CORSRule" - } - } - }, - "GetBucketCorsRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketLifecycleOutput":{ - "type":"structure", - "members":{ - "Rules":{ - "shape":"Rules", - "locationName":"Rule" - } - } - }, - "GetBucketLifecycleRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketLocationOutput":{ - "type":"structure", - "members":{ - "LocationConstraint":{"shape":"BucketLocationConstraint"} - } - }, - "GetBucketLocationRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketLoggingOutput":{ - "type":"structure", - "members":{ - "LoggingEnabled":{"shape":"LoggingEnabled"} - } - }, - "GetBucketLoggingRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketNotificationOutput":{ - "type":"structure", - "members":{ - "TopicConfiguration":{"shape":"TopicConfiguration"}, - "QueueConfiguration":{"shape":"QueueConfiguration"}, - "CloudFunctionConfiguration":{"shape":"CloudFunctionConfiguration"} - } - }, - "GetBucketNotificationRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketPolicyOutput":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"Policy", - "documentation":"The bucket policy as a JSON document." - } - }, - "payload":"Policy" - }, - "GetBucketPolicyRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketRequestPaymentOutput":{ - "type":"structure", - "members":{ - "Payer":{ - "shape":"Payer", - "documentation":"Specifies who pays for the download and request fees." - } - } - }, - "GetBucketRequestPaymentRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketTaggingOutput":{ - "type":"structure", - "required":["TagSet"], - "members":{ - "TagSet":{"shape":"TagSet"} - } - }, - "GetBucketTaggingRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketVersioningOutput":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"BucketVersioningStatus", - "documentation":"The versioning state of the bucket." - }, - "MFADelete":{ - "shape":"MFADeleteStatus", - "documentation":"Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.", - "locationName":"MfaDelete" - } - } - }, - "GetBucketVersioningRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetBucketWebsiteOutput":{ - "type":"structure", - "members":{ - "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, - "IndexDocument":{"shape":"IndexDocument"}, - "ErrorDocument":{"shape":"ErrorDocument"}, - "RoutingRules":{"shape":"RoutingRules"} - } - }, - "GetBucketWebsiteRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "GetObjectAclOutput":{ - "type":"structure", - "members":{ - "Owner":{"shape":"Owner"}, - "Grants":{ - "shape":"Grants", - "documentation":"A list of grants.", - "locationName":"AccessControlList" - } - } - }, - "GetObjectAclRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"querystring", - "locationName":"versionId", - "documentation":"VersionId used to reference a specific version of the object." - } - } - }, - "GetObjectOutput":{ - "type":"structure", - "members":{ - "Body":{ - "shape":"Body", - "streaming":true, - "documentation":"Object data." - }, - "DeleteMarker":{ - "shape":"DeleteMarker", - "location":"header", - "locationName":"x-amz-delete-marker", - "documentation":"Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." - }, - "AcceptRanges":{ - "shape":"AcceptRanges", - "location":"header", - "locationName":"accept-ranges" - }, - "Expiration":{ - "shape":"Expiration", - "location":"header", - "locationName":"x-amz-expiration", - "documentation":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded." - }, - "Restore":{ - "shape":"Restore", - "location":"header", - "locationName":"x-amz-restore", - "documentation":"Provides information about object restoration operation and expiration time of the restored object copy." - }, - "LastModified":{ - "shape":"LastModified", - "location":"header", - "locationName":"Last-Modified", - "documentation":"Last modified date of the object" - }, - "ContentLength":{ - "shape":"ContentLength", - "location":"header", - "locationName":"Content-Length", - "documentation":"Size of the body in bytes." - }, - "ETag":{ - "shape":"ETag", - "location":"header", - "locationName":"ETag", - "documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL" - }, - "MissingMeta":{ - "shape":"MissingMeta", - "location":"header", - "locationName":"x-amz-missing-meta", - "documentation":"This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"header", - "locationName":"x-amz-version-id", - "documentation":"Version of the object." - }, - "CacheControl":{ - "shape":"CacheControl", - "location":"header", - "locationName":"Cache-Control", - "documentation":"Specifies caching behavior along the request/reply chain." - }, - "ContentDisposition":{ - "shape":"ContentDisposition", - "location":"header", - "locationName":"Content-Disposition", - "documentation":"Specifies presentational information for the object." - }, - "ContentEncoding":{ - "shape":"ContentEncoding", - "location":"header", - "locationName":"Content-Encoding", - "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." - }, - "ContentLanguage":{ - "shape":"ContentLanguage", - "location":"header", - "locationName":"Content-Language", - "documentation":"The language the content is in." - }, - "ContentType":{ - "shape":"ContentType", - "location":"header", - "locationName":"Content-Type", - "documentation":"A standard MIME type describing the format of the object data." - }, - "Expires":{ - "shape":"Expires", - "location":"header", - "locationName":"Expires", - "documentation":"The date and time at which the object is no longer cacheable." - }, - "WebsiteRedirectLocation":{ - "shape":"WebsiteRedirectLocation", - "location":"header", - "locationName":"x-amz-website-redirect-location", - "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "Metadata":{ - "shape":"Metadata", - "location":"headers", - "documentation":"A map of metadata to store with the object in S3.", - "locationName":"x-amz-meta-" - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - }, - "payload":"Body" - }, - "GetObjectRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "IfMatch":{ - "shape":"IfMatch", - "location":"header", - "locationName":"If-Match", - "documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." - }, - "IfModifiedSince":{ - "shape":"IfModifiedSince", - "location":"header", - "locationName":"If-Modified-Since", - "documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." - }, - "IfNoneMatch":{ - "shape":"IfNoneMatch", - "location":"header", - "locationName":"If-None-Match", - "documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." - }, - "IfUnmodifiedSince":{ - "shape":"IfUnmodifiedSince", - "location":"header", - "locationName":"If-Unmodified-Since", - "documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "Range":{ - "shape":"Range", - "location":"header", - "locationName":"Range", - "documentation":"Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." - }, - "ResponseCacheControl":{ - "shape":"ResponseCacheControl", - "location":"querystring", - "locationName":"response-cache-control", - "documentation":"Sets the Cache-Control header of the response." - }, - "ResponseContentDisposition":{ - "shape":"ResponseContentDisposition", - "location":"querystring", - "locationName":"response-content-disposition", - "documentation":"Sets the Content-Disposition header of the response" - }, - "ResponseContentEncoding":{ - "shape":"ResponseContentEncoding", - "location":"querystring", - "locationName":"response-content-encoding", - "documentation":"Sets the Content-Encoding header of the response." - }, - "ResponseContentLanguage":{ - "shape":"ResponseContentLanguage", - "location":"querystring", - "locationName":"response-content-language", - "documentation":"Sets the Content-Language header of the response." - }, - "ResponseContentType":{ - "shape":"ResponseContentType", - "location":"querystring", - "locationName":"response-content-type", - "documentation":"Sets the Content-Type header of the response." - }, - "ResponseExpires":{ - "shape":"ResponseExpires", - "location":"querystring", - "locationName":"response-expires", - "documentation":"Sets the Expires header of the response." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"querystring", - "locationName":"versionId", - "documentation":"VersionId used to reference a specific version of the object." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - } - } - }, - "GetObjectTorrentOutput":{ - "type":"structure", - "members":{ - "Body":{ - "shape":"Body", - "streaming":true - } - }, - "payload":"Body" - }, - "GetObjectTorrentRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - } - } - }, - "Grant":{ - "type":"structure", - "members":{ - "Grantee":{"shape":"Grantee"}, - "Permission":{ - "shape":"Permission", - "documentation":"Specifies the permission given to the grantee." - } - } - }, - "GrantFullControl":{"type":"string"}, - "GrantRead":{"type":"string"}, - "GrantReadACP":{"type":"string"}, - "GrantWrite":{"type":"string"}, - "GrantWriteACP":{"type":"string"}, - "Grantee":{ - "type":"structure", - "required":["Type"], - "members":{ - "DisplayName":{ - "shape":"DisplayName", - "documentation":"Screen name of the grantee." - }, - "EmailAddress":{ - "shape":"EmailAddress", - "documentation":"Email address of the grantee." - }, - "ID":{ - "shape":"ID", - "documentation":"The canonical user ID of the grantee." - }, - "Type":{ - "shape":"Type", - "documentation":"Type of grantee" - }, - "URI":{ - "shape":"URI", - "documentation":"URI of the grantee group." - } - }, - "xmlNamespace":{ - "prefix":"xsi", - "uri":"http://www.w3.org/2001/XMLSchema-instance" - } - }, - "Grants":{ - "type":"list", - "member":{ - "shape":"Grant", - "locationName":"Grant" - } - }, - "HeadBucketRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - } - } - }, - "HeadObjectOutput":{ - "type":"structure", - "members":{ - "DeleteMarker":{ - "shape":"DeleteMarker", - "location":"header", - "locationName":"x-amz-delete-marker", - "documentation":"Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." - }, - "AcceptRanges":{ - "shape":"AcceptRanges", - "location":"header", - "locationName":"accept-ranges" - }, - "Expiration":{ - "shape":"Expiration", - "location":"header", - "locationName":"x-amz-expiration", - "documentation":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded." - }, - "Restore":{ - "shape":"Restore", - "location":"header", - "locationName":"x-amz-restore", - "documentation":"Provides information about object restoration operation and expiration time of the restored object copy." - }, - "LastModified":{ - "shape":"LastModified", - "location":"header", - "locationName":"Last-Modified", - "documentation":"Last modified date of the object" - }, - "ContentLength":{ - "shape":"ContentLength", - "location":"header", - "locationName":"Content-Length", - "documentation":"Size of the body in bytes." - }, - "ETag":{ - "shape":"ETag", - "location":"header", - "locationName":"ETag", - "documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL" - }, - "MissingMeta":{ - "shape":"MissingMeta", - "location":"header", - "locationName":"x-amz-missing-meta", - "documentation":"This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"header", - "locationName":"x-amz-version-id", - "documentation":"Version of the object." - }, - "CacheControl":{ - "shape":"CacheControl", - "location":"header", - "locationName":"Cache-Control", - "documentation":"Specifies caching behavior along the request/reply chain." - }, - "ContentDisposition":{ - "shape":"ContentDisposition", - "location":"header", - "locationName":"Content-Disposition", - "documentation":"Specifies presentational information for the object." - }, - "ContentEncoding":{ - "shape":"ContentEncoding", - "location":"header", - "locationName":"Content-Encoding", - "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." - }, - "ContentLanguage":{ - "shape":"ContentLanguage", - "location":"header", - "locationName":"Content-Language", - "documentation":"The language the content is in." - }, - "ContentType":{ - "shape":"ContentType", - "location":"header", - "locationName":"Content-Type", - "documentation":"A standard MIME type describing the format of the object data." - }, - "Expires":{ - "shape":"Expires", - "location":"header", - "locationName":"Expires", - "documentation":"The date and time at which the object is no longer cacheable." - }, - "WebsiteRedirectLocation":{ - "shape":"WebsiteRedirectLocation", - "location":"header", - "locationName":"x-amz-website-redirect-location", - "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "Metadata":{ - "shape":"Metadata", - "location":"headers", - "documentation":"A map of metadata to store with the object in S3.", - "locationName":"x-amz-meta-" - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - } - }, - "HeadObjectRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "IfMatch":{ - "shape":"IfMatch", - "location":"header", - "locationName":"If-Match", - "documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." - }, - "IfModifiedSince":{ - "shape":"IfModifiedSince", - "location":"header", - "locationName":"If-Modified-Since", - "documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." - }, - "IfNoneMatch":{ - "shape":"IfNoneMatch", - "location":"header", - "locationName":"If-None-Match", - "documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." - }, - "IfUnmodifiedSince":{ - "shape":"IfUnmodifiedSince", - "location":"header", - "locationName":"If-Unmodified-Since", - "documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "Range":{ - "shape":"Range", - "location":"header", - "locationName":"Range", - "documentation":"Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"querystring", - "locationName":"versionId", - "documentation":"VersionId used to reference a specific version of the object." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - } - } - }, - "HostName":{"type":"string"}, - "HttpErrorCodeReturnedEquals":{"type":"string"}, - "HttpRedirectCode":{"type":"string"}, - "ID":{"type":"string"}, - "IfMatch":{"type":"string"}, - "IfModifiedSince":{"type":"timestamp"}, - "IfNoneMatch":{"type":"string"}, - "IfUnmodifiedSince":{"type":"timestamp"}, - "IndexDocument":{ - "type":"structure", - "required":["Suffix"], - "members":{ - "Suffix":{ - "shape":"Suffix", - "documentation":"A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character." - } - } - }, - "Initiated":{"type":"timestamp"}, - "Initiator":{ - "type":"structure", - "members":{ - "ID":{ - "shape":"ID", - "documentation":"If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value." - }, - "DisplayName":{ - "shape":"DisplayName", - "documentation":"Name of the Principal." - } - } - }, - "IsLatest":{"type":"boolean"}, - "IsTruncated":{"type":"boolean"}, - "KeyMarker":{"type":"string"}, - "KeyPrefixEquals":{"type":"string"}, - "LastModified":{"type":"timestamp"}, - "LifecycleConfiguration":{ - "type":"structure", - "required":["Rules"], - "members":{ - "Rules":{ - "shape":"Rules", - "locationName":"Rule" - } - } - }, - "LifecycleExpiration":{ - "type":"structure", - "members":{ - "Date":{ - "shape":"Date", - "documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." - }, - "Days":{ - "shape":"Days", - "documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." - } - } - }, - "ListBucketsOutput":{ - "type":"structure", - "members":{ - "Buckets":{"shape":"Buckets"}, - "Owner":{"shape":"Owner"} - } - }, - "ListMultipartUploadsOutput":{ - "type":"structure", - "members":{ - "Bucket":{ - "shape":"BucketName", - "documentation":"Name of the bucket to which the multipart upload was initiated." - }, - "KeyMarker":{ - "shape":"KeyMarker", - "documentation":"The key at or after which the listing began." - }, - "UploadIdMarker":{ - "shape":"UploadIdMarker", - "documentation":"Upload ID after which listing began." - }, - "NextKeyMarker":{ - "shape":"NextKeyMarker", - "documentation":"When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request." - }, - "Prefix":{ - "shape":"Prefix", - "documentation":"When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix." - }, - "Delimiter":{"shape":"Delimiter"}, - "NextUploadIdMarker":{ - "shape":"NextUploadIdMarker", - "documentation":"When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request." - }, - "MaxUploads":{ - "shape":"MaxUploads", - "documentation":"Maximum number of multipart uploads that could have been included in the response." - }, - "IsTruncated":{ - "shape":"IsTruncated", - "documentation":"Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads." - }, - "Uploads":{ - "shape":"MultipartUploadList", - "locationName":"Upload" - }, - "CommonPrefixes":{"shape":"CommonPrefixList"}, - "EncodingType":{ - "shape":"EncodingType", - "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." - } - } - }, - "ListMultipartUploadsRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Delimiter":{ - "shape":"Delimiter", - "location":"querystring", - "locationName":"delimiter", - "documentation":"Character you use to group keys." - }, - "EncodingType":{ - "shape":"EncodingType", - "location":"querystring", - "locationName":"encoding-type" - }, - "KeyMarker":{ - "shape":"KeyMarker", - "location":"querystring", - "locationName":"key-marker", - "documentation":"Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin." - }, - "MaxUploads":{ - "shape":"MaxUploads", - "location":"querystring", - "locationName":"max-uploads", - "documentation":"Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response." - }, - "Prefix":{ - "shape":"Prefix", - "location":"querystring", - "locationName":"prefix", - "documentation":"Lists in-progress uploads only for those keys that begin with the specified prefix." - }, - "UploadIdMarker":{ - "shape":"UploadIdMarker", - "location":"querystring", - "locationName":"upload-id-marker", - "documentation":"Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored." - } - } - }, - "ListObjectVersionsOutput":{ - "type":"structure", - "members":{ - "IsTruncated":{ - "shape":"IsTruncated", - "documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results." - }, - "KeyMarker":{ - "shape":"KeyMarker", - "documentation":"Marks the last Key returned in a truncated response." - }, - "VersionIdMarker":{"shape":"VersionIdMarker"}, - "NextKeyMarker":{ - "shape":"NextKeyMarker", - "documentation":"Use this value for the key marker request parameter in a subsequent request." - }, - "NextVersionIdMarker":{ - "shape":"NextVersionIdMarker", - "documentation":"Use this value for the next version id marker parameter in a subsequent request." - }, - "Versions":{ - "shape":"ObjectVersionList", - "locationName":"Version" - }, - "DeleteMarkers":{ - "shape":"DeleteMarkers", - "locationName":"DeleteMarker" - }, - "Name":{"shape":"BucketName"}, - "Prefix":{"shape":"Prefix"}, - "Delimiter":{"shape":"Delimiter"}, - "MaxKeys":{"shape":"MaxKeys"}, - "CommonPrefixes":{"shape":"CommonPrefixList"}, - "EncodingType":{ - "shape":"EncodingType", - "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." - } - } - }, - "ListObjectVersionsRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Delimiter":{ - "shape":"Delimiter", - "location":"querystring", - "locationName":"delimiter", - "documentation":"A delimiter is a character you use to group keys." - }, - "EncodingType":{ - "shape":"EncodingType", - "location":"querystring", - "locationName":"encoding-type" - }, - "KeyMarker":{ - "shape":"KeyMarker", - "location":"querystring", - "locationName":"key-marker", - "documentation":"Specifies the key to start with when listing objects in a bucket." - }, - "MaxKeys":{ - "shape":"MaxKeys", - "location":"querystring", - "locationName":"max-keys", - "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." - }, - "Prefix":{ - "shape":"Prefix", - "location":"querystring", - "locationName":"prefix", - "documentation":"Limits the response to keys that begin with the specified prefix." - }, - "VersionIdMarker":{ - "shape":"VersionIdMarker", - "location":"querystring", - "locationName":"version-id-marker", - "documentation":"Specifies the object version you want to start listing from." - } - } - }, - "ListObjectsOutput":{ - "type":"structure", - "members":{ - "IsTruncated":{ - "shape":"IsTruncated", - "documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria." - }, - "Marker":{"shape":"Marker"}, - "NextMarker":{ - "shape":"NextMarker", - "documentation":"When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys." - }, - "Contents":{"shape":"ObjectList"}, - "Name":{"shape":"BucketName"}, - "Prefix":{"shape":"Prefix"}, - "Delimiter":{"shape":"Delimiter"}, - "MaxKeys":{"shape":"MaxKeys"}, - "CommonPrefixes":{"shape":"CommonPrefixList"}, - "EncodingType":{ - "shape":"EncodingType", - "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." - } - } - }, - "ListObjectsRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Delimiter":{ - "shape":"Delimiter", - "location":"querystring", - "locationName":"delimiter", - "documentation":"A delimiter is a character you use to group keys." - }, - "EncodingType":{ - "shape":"EncodingType", - "location":"querystring", - "locationName":"encoding-type" - }, - "Marker":{ - "shape":"Marker", - "location":"querystring", - "locationName":"marker", - "documentation":"Specifies the key to start with when listing objects in a bucket." - }, - "MaxKeys":{ - "shape":"MaxKeys", - "location":"querystring", - "locationName":"max-keys", - "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." - }, - "Prefix":{ - "shape":"Prefix", - "location":"querystring", - "locationName":"prefix", - "documentation":"Limits the response to keys that begin with the specified prefix." - } - } - }, - "ListPartsOutput":{ - "type":"structure", - "members":{ - "Bucket":{ - "shape":"BucketName", - "documentation":"Name of the bucket to which the multipart upload was initiated." - }, - "Key":{ - "shape":"ObjectKey", - "documentation":"Object key for which the multipart upload was initiated." - }, - "UploadId":{ - "shape":"MultipartUploadId", - "documentation":"Upload ID identifying the multipart upload whose parts are being listed." - }, - "PartNumberMarker":{ - "shape":"PartNumberMarker", - "documentation":"Part number after which listing begins." - }, - "NextPartNumberMarker":{ - "shape":"NextPartNumberMarker", - "documentation":"When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request." - }, - "MaxParts":{ - "shape":"MaxParts", - "documentation":"Maximum number of parts that were allowed in the response." - }, - "IsTruncated":{ - "shape":"IsTruncated", - "documentation":"Indicates whether the returned list of parts is truncated." - }, - "Parts":{ - "shape":"Parts", - "locationName":"Part" - }, - "Initiator":{ - "shape":"Initiator", - "documentation":"Identifies who initiated the multipart upload." - }, - "Owner":{"shape":"Owner"}, - "StorageClass":{ - "shape":"StorageClass", - "documentation":"The class of storage used to store the object." - } - } - }, - "ListPartsRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key", - "UploadId" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "MaxParts":{ - "shape":"MaxParts", - "location":"querystring", - "locationName":"max-parts", - "documentation":"Sets the maximum number of parts to return." - }, - "PartNumberMarker":{ - "shape":"PartNumberMarker", - "location":"querystring", - "locationName":"part-number-marker", - "documentation":"Specifies the part after which listing should begin. Only parts with higher part numbers will be listed." - }, - "UploadId":{ - "shape":"MultipartUploadId", - "location":"querystring", - "locationName":"uploadId", - "documentation":"Upload ID identifying the multipart upload whose parts are being listed." - } - } - }, - "Location":{"type":"string"}, - "LoggingEnabled":{ - "type":"structure", - "members":{ - "TargetBucket":{ - "shape":"TargetBucket", - "documentation":"Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key." - }, - "TargetGrants":{"shape":"TargetGrants"}, - "TargetPrefix":{ - "shape":"TargetPrefix", - "documentation":"This element lets you specify a prefix for the keys that the log files will be stored under." - } - } - }, - "MFA":{"type":"string"}, - "MFADelete":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "MFADeleteStatus":{ - "type":"string", - "enum":[ - "Enabled", - "Disabled" - ] - }, - "Marker":{"type":"string"}, - "MaxAgeSeconds":{"type":"integer"}, - "MaxKeys":{"type":"integer"}, - "MaxParts":{"type":"integer"}, - "MaxUploads":{"type":"integer"}, - "Message":{"type":"string"}, - "Metadata":{ - "type":"map", - "key":{"shape":"MetadataKey"}, - "value":{"shape":"MetadataValue"} - }, - "MetadataDirective":{ - "type":"string", - "enum":[ - "COPY", - "REPLACE" - ] - }, - "MetadataKey":{"type":"string"}, - "MetadataValue":{"type":"string"}, - "MissingMeta":{"type":"integer"}, - "MultipartUpload":{ - "type":"structure", - "members":{ - "UploadId":{ - "shape":"MultipartUploadId", - "documentation":"Upload ID that identifies the multipart upload." - }, - "Key":{ - "shape":"ObjectKey", - "documentation":"Key of the object for which the multipart upload was initiated." - }, - "Initiated":{ - "shape":"Initiated", - "documentation":"Date and time at which the multipart upload was initiated." - }, - "StorageClass":{ - "shape":"StorageClass", - "documentation":"The class of storage used to store the object." - }, - "Owner":{"shape":"Owner"}, - "Initiator":{ - "shape":"Initiator", - "documentation":"Identifies who initiated the multipart upload." - } - } - }, - "MultipartUploadId":{"type":"string"}, - "MultipartUploadList":{ - "type":"list", - "member":{"shape":"MultipartUpload"}, - "flattened":true - }, - "NextKeyMarker":{"type":"string"}, - "NextMarker":{"type":"string"}, - "NextPartNumberMarker":{"type":"integer"}, - "NextUploadIdMarker":{"type":"string"}, - "NextVersionIdMarker":{"type":"string"}, - "NoSuchBucket":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified bucket does not exist." - }, - "NoSuchKey":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified key does not exist." - }, - "NoSuchUpload":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The specified multipart upload does not exist." - }, - "NoncurrentVersionExpiration":{ - "type":"structure", - "members":{ - "NoncurrentDays":{ - "shape":"Days", - "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide." - } - }, - "documentation":"Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime." - }, - "NoncurrentVersionTransition":{ - "type":"structure", - "members":{ - "NoncurrentDays":{ - "shape":"Days", - "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide." - }, - "StorageClass":{ - "shape":"TransitionStorageClass", - "documentation":"The class of storage used to store the object." - } - }, - "documentation":"Container for the transition rule that describes when noncurrent objects transition to the GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the GLACIER storage class at a specific period in the object's lifetime." - }, - "NotificationConfiguration":{ - "type":"structure", - "members":{ - "TopicConfiguration":{"shape":"TopicConfiguration"}, - "QueueConfiguration":{"shape":"QueueConfiguration"}, - "CloudFunctionConfiguration":{"shape":"CloudFunctionConfiguration"} - } - }, - "NotificationId":{"type":"string"}, - "Object":{ - "type":"structure", - "members":{ - "Key":{"shape":"ObjectKey"}, - "LastModified":{"shape":"LastModified"}, - "ETag":{"shape":"ETag"}, - "Size":{"shape":"Size"}, - "StorageClass":{ - "shape":"ObjectStorageClass", - "documentation":"The class of storage used to store the object." - }, - "Owner":{"shape":"Owner"} - } - }, - "ObjectAlreadyInActiveTierError":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"This operation is not allowed against this storage tier" - }, - "ObjectCannedACL":{ - "type":"string", - "enum":[ - "private", - "public-read", - "public-read-write", - "authenticated-read", - "bucket-owner-read", - "bucket-owner-full-control" - ] - }, - "ObjectIdentifier":{ - "type":"structure", - "required":["Key"], - "members":{ - "Key":{ - "shape":"ObjectKey", - "documentation":"Key name of the object to delete." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "documentation":"VersionId for the specific version of the object to delete." - } - } - }, - "ObjectIdentifierList":{ - "type":"list", - "member":{"shape":"ObjectIdentifier"}, - "flattened":true - }, - "ObjectKey":{"type":"string"}, - "ObjectList":{ - "type":"list", - "member":{"shape":"Object"}, - "flattened":true - }, - "ObjectNotInActiveTierError":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier." - }, - "ObjectStorageClass":{ - "type":"string", - "enum":[ - "STANDARD", - "REDUCED_REDUNDANCY", - "GLACIER" - ] - }, - "ObjectVersion":{ - "type":"structure", - "members":{ - "ETag":{"shape":"ETag"}, - "Size":{ - "shape":"Size", - "documentation":"Size in bytes of the object." - }, - "StorageClass":{ - "shape":"ObjectVersionStorageClass", - "documentation":"The class of storage used to store the object." - }, - "Key":{ - "shape":"ObjectKey", - "documentation":"The object key." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "documentation":"Version ID of an object." - }, - "IsLatest":{ - "shape":"IsLatest", - "documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object." - }, - "LastModified":{ - "shape":"LastModified", - "documentation":"Date and time the object was last modified." - }, - "Owner":{"shape":"Owner"} - } - }, - "ObjectVersionId":{"type":"string"}, - "ObjectVersionList":{ - "type":"list", - "member":{"shape":"ObjectVersion"}, - "flattened":true - }, - "ObjectVersionStorageClass":{ - "type":"string", - "enum":["STANDARD"] - }, - "Owner":{ - "type":"structure", - "members":{ - "DisplayName":{"shape":"DisplayName"}, - "ID":{"shape":"ID"} - } - }, - "Part":{ - "type":"structure", - "members":{ - "PartNumber":{ - "shape":"PartNumber", - "documentation":"Part number identifying the part." - }, - "LastModified":{ - "shape":"LastModified", - "documentation":"Date and time at which the part was uploaded." - }, - "ETag":{ - "shape":"ETag", - "documentation":"Entity tag returned when the part was uploaded." - }, - "Size":{ - "shape":"Size", - "documentation":"Size of the uploaded part data." - } - } - }, - "PartNumber":{"type":"integer"}, - "PartNumberMarker":{"type":"integer"}, - "Parts":{ - "type":"list", - "member":{"shape":"Part"}, - "flattened":true - }, - "Payer":{ - "type":"string", - "enum":[ - "Requester", - "BucketOwner" - ] - }, - "Permission":{ - "type":"string", - "enum":[ - "FULL_CONTROL", - "WRITE", - "WRITE_ACP", - "READ", - "READ_ACP" - ] - }, - "Policy":{"type":"string"}, - "Prefix":{"type":"string"}, - "Protocol":{ - "type":"string", - "enum":[ - "http", - "https" - ] - }, - "PutBucketAclRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "ACL":{ - "shape":"BucketCannedACL", - "location":"header", - "locationName":"x-amz-acl", - "documentation":"The canned ACL to apply to the bucket." - }, - "AccessControlPolicy":{ - "shape":"AccessControlPolicy", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"AccessControlPolicy" - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "GrantFullControl":{ - "shape":"GrantFullControl", - "location":"header", - "locationName":"x-amz-grant-full-control", - "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." - }, - "GrantRead":{ - "shape":"GrantRead", - "location":"header", - "locationName":"x-amz-grant-read", - "documentation":"Allows grantee to list the objects in the bucket." - }, - "GrantReadACP":{ - "shape":"GrantReadACP", - "location":"header", - "locationName":"x-amz-grant-read-acp", - "documentation":"Allows grantee to read the bucket ACL." - }, - "GrantWrite":{ - "shape":"GrantWrite", - "location":"header", - "locationName":"x-amz-grant-write", - "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket." - }, - "GrantWriteACP":{ - "shape":"GrantWriteACP", - "location":"header", - "locationName":"x-amz-grant-write-acp", - "documentation":"Allows grantee to write the ACL for the applicable bucket." - } - }, - "payload":"AccessControlPolicy" - }, - "PutBucketCorsRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "CORSConfiguration":{ - "shape":"CORSConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"CORSConfiguration" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - } - }, - "payload":"CORSConfiguration" - }, - "PutBucketLifecycleRequest":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "LifecycleConfiguration":{ - "shape":"LifecycleConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"LifecycleConfiguration" - } - }, - "payload":"LifecycleConfiguration" - }, - "PutBucketLoggingRequest":{ - "type":"structure", - "required":[ - "Bucket", - "BucketLoggingStatus" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "BucketLoggingStatus":{ - "shape":"BucketLoggingStatus", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"BucketLoggingStatus" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - } - }, - "payload":"BucketLoggingStatus" - }, - "PutBucketNotificationRequest":{ - "type":"structure", - "required":[ - "Bucket", - "NotificationConfiguration" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "NotificationConfiguration":{ - "shape":"NotificationConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"NotificationConfiguration" - } - }, - "payload":"NotificationConfiguration" - }, - "PutBucketPolicyRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Policy" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "Policy":{ - "shape":"Policy", - "documentation":"The bucket policy as a JSON document." - } - }, - "payload":"Policy" - }, - "PutBucketRequestPaymentRequest":{ - "type":"structure", - "required":[ - "Bucket", - "RequestPaymentConfiguration" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "RequestPaymentConfiguration":{ - "shape":"RequestPaymentConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"RequestPaymentConfiguration" - } - }, - "payload":"RequestPaymentConfiguration" - }, - "PutBucketTaggingRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Tagging" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "Tagging":{ - "shape":"Tagging", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"Tagging" - } - }, - "payload":"Tagging" - }, - "PutBucketVersioningRequest":{ - "type":"structure", - "required":[ - "Bucket", - "VersioningConfiguration" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "MFA":{ - "shape":"MFA", - "location":"header", - "locationName":"x-amz-mfa", - "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." - }, - "VersioningConfiguration":{ - "shape":"VersioningConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"VersioningConfiguration" - } - }, - "payload":"VersioningConfiguration" - }, - "PutBucketWebsiteRequest":{ - "type":"structure", - "required":[ - "Bucket", - "WebsiteConfiguration" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "WebsiteConfiguration":{ - "shape":"WebsiteConfiguration", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"WebsiteConfiguration" - } - }, - "payload":"WebsiteConfiguration" - }, - "PutObjectAclRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "ACL":{ - "shape":"ObjectCannedACL", - "location":"header", - "locationName":"x-amz-acl", - "documentation":"The canned ACL to apply to the object." - }, - "AccessControlPolicy":{ - "shape":"AccessControlPolicy", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"AccessControlPolicy" - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "GrantFullControl":{ - "shape":"GrantFullControl", - "location":"header", - "locationName":"x-amz-grant-full-control", - "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." - }, - "GrantRead":{ - "shape":"GrantRead", - "location":"header", - "locationName":"x-amz-grant-read", - "documentation":"Allows grantee to list the objects in the bucket." - }, - "GrantReadACP":{ - "shape":"GrantReadACP", - "location":"header", - "locationName":"x-amz-grant-read-acp", - "documentation":"Allows grantee to read the bucket ACL." - }, - "GrantWrite":{ - "shape":"GrantWrite", - "location":"header", - "locationName":"x-amz-grant-write", - "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket." - }, - "GrantWriteACP":{ - "shape":"GrantWriteACP", - "location":"header", - "locationName":"x-amz-grant-write-acp", - "documentation":"Allows grantee to write the ACL for the applicable bucket." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - } - }, - "payload":"AccessControlPolicy" - }, - "PutObjectOutput":{ - "type":"structure", - "members":{ - "Expiration":{ - "shape":"Expiration", - "location":"header", - "locationName":"x-amz-expiration", - "documentation":"If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." - }, - "ETag":{ - "shape":"ETag", - "location":"header", - "locationName":"ETag", - "documentation":"Entity tag for the uploaded object." - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"header", - "locationName":"x-amz-version-id", - "documentation":"Version of the object." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - } - }, - "PutObjectRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "ACL":{ - "shape":"ObjectCannedACL", - "location":"header", - "locationName":"x-amz-acl", - "documentation":"The canned ACL to apply to the object." - }, - "Body":{ - "shape":"Body", - "streaming":true, - "documentation":"Object data." - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "CacheControl":{ - "shape":"CacheControl", - "location":"header", - "locationName":"Cache-Control", - "documentation":"Specifies caching behavior along the request/reply chain." - }, - "ContentDisposition":{ - "shape":"ContentDisposition", - "location":"header", - "locationName":"Content-Disposition", - "documentation":"Specifies presentational information for the object." - }, - "ContentEncoding":{ - "shape":"ContentEncoding", - "location":"header", - "locationName":"Content-Encoding", - "documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." - }, - "ContentLanguage":{ - "shape":"ContentLanguage", - "location":"header", - "locationName":"Content-Language", - "documentation":"The language the content is in." - }, - "ContentLength":{ - "shape":"ContentLength", - "location":"header", - "locationName":"Content-Length", - "documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "ContentType":{ - "shape":"ContentType", - "location":"header", - "locationName":"Content-Type", - "documentation":"A standard MIME type describing the format of the object data." - }, - "Expires":{ - "shape":"Expires", - "location":"header", - "locationName":"Expires", - "documentation":"The date and time at which the object is no longer cacheable." - }, - "GrantFullControl":{ - "shape":"GrantFullControl", - "location":"header", - "locationName":"x-amz-grant-full-control", - "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." - }, - "GrantRead":{ - "shape":"GrantRead", - "location":"header", - "locationName":"x-amz-grant-read", - "documentation":"Allows grantee to read the object data and its metadata." - }, - "GrantReadACP":{ - "shape":"GrantReadACP", - "location":"header", - "locationName":"x-amz-grant-read-acp", - "documentation":"Allows grantee to read the object ACL." - }, - "GrantWriteACP":{ - "shape":"GrantWriteACP", - "location":"header", - "locationName":"x-amz-grant-write-acp", - "documentation":"Allows grantee to write the ACL for the applicable object." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "Metadata":{ - "shape":"Metadata", - "location":"headers", - "documentation":"A map of metadata to store with the object in S3.", - "locationName":"x-amz-meta-" - }, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "StorageClass":{ - "shape":"StorageClass", - "location":"header", - "locationName":"x-amz-storage-class", - "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'." - }, - "WebsiteRedirectLocation":{ - "shape":"WebsiteRedirectLocation", - "location":"header", - "locationName":"x-amz-website-redirect-location", - "documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version" - } - }, - "payload":"Body" - }, - "Queue":{"type":"string"}, - "QueueConfiguration":{ - "type":"structure", - "members":{ - "Id":{"shape":"NotificationId"}, - "Event":{ - "shape":"Event", - "deprecated":true - }, - "Events":{ - "shape":"Events", - "locationName":"Event" - }, - "Queue":{"shape":"Queue"} - } - }, - "Quiet":{"type":"boolean"}, - "Range":{"type":"string"}, - "Redirect":{ - "type":"structure", - "members":{ - "HostName":{ - "shape":"HostName", - "documentation":"The host name to use in the redirect request." - }, - "HttpRedirectCode":{ - "shape":"HttpRedirectCode", - "documentation":"The HTTP redirect code to use on the response. Not required if one of the siblings is present." - }, - "Protocol":{ - "shape":"Protocol", - "documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." - }, - "ReplaceKeyPrefixWith":{ - "shape":"ReplaceKeyPrefixWith", - "documentation":"The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided." - }, - "ReplaceKeyWith":{ - "shape":"ReplaceKeyWith", - "documentation":"The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided." - } - } - }, - "RedirectAllRequestsTo":{ - "type":"structure", - "required":["HostName"], - "members":{ - "HostName":{ - "shape":"HostName", - "documentation":"Name of the host where requests will be redirected." - }, - "Protocol":{ - "shape":"Protocol", - "documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." - } - } - }, - "ReplaceKeyPrefixWith":{"type":"string"}, - "ReplaceKeyWith":{"type":"string"}, - "RequestPaymentConfiguration":{ - "type":"structure", - "required":["Payer"], - "members":{ - "Payer":{ - "shape":"Payer", - "documentation":"Specifies who pays for the download and request fees." - } - } - }, - "ResponseCacheControl":{"type":"string"}, - "ResponseContentDisposition":{"type":"string"}, - "ResponseContentEncoding":{"type":"string"}, - "ResponseContentLanguage":{"type":"string"}, - "ResponseContentType":{"type":"string"}, - "ResponseExpires":{"type":"timestamp"}, - "Restore":{"type":"string"}, - "RestoreObjectRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "VersionId":{ - "shape":"ObjectVersionId", - "location":"querystring", - "locationName":"versionId" - }, - "RestoreRequest":{ - "shape":"RestoreRequest", - "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}, - "locationName":"RestoreRequest" - } - }, - "payload":"RestoreRequest" - }, - "RestoreRequest":{ - "type":"structure", - "required":["Days"], - "members":{ - "Days":{ - "shape":"Days", - "documentation":"Lifetime of the active copy in days" - } - } - }, - "RoutingRule":{ - "type":"structure", - "required":["Redirect"], - "members":{ - "Condition":{ - "shape":"Condition", - "documentation":"A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." - }, - "Redirect":{ - "shape":"Redirect", - "documentation":"Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return." - } - } - }, - "RoutingRules":{ - "type":"list", - "member":{ - "shape":"RoutingRule", - "locationName":"RoutingRule" - } - }, - "Rule":{ - "type":"structure", - "required":[ - "Prefix", - "Status" - ], - "members":{ - "Expiration":{"shape":"LifecycleExpiration"}, - "ID":{ - "shape":"ID", - "documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters." - }, - "Prefix":{ - "shape":"Prefix", - "documentation":"Prefix identifying one or more objects to which the rule applies." - }, - "Status":{ - "shape":"ExpirationStatus", - "documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." - }, - "Transition":{"shape":"Transition"}, - "NoncurrentVersionTransition":{"shape":"NoncurrentVersionTransition"}, - "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"} - } - }, - "Rules":{ - "type":"list", - "member":{"shape":"Rule"}, - "flattened":true - }, - "SSECustomerAlgorithm":{"type":"string"}, - "SSECustomerKey":{ - "type":"string", - "sensitive":true - }, - "SSECustomerKeyMD5":{"type":"string"}, - "SSEKMSKeyId":{ - "type":"string", - "sensitive":true - }, - "ServerSideEncryption":{ - "type":"string", - "enum":["AES256"] - }, - "Size":{"type":"integer"}, - "StorageClass":{ - "type":"string", - "enum":[ - "STANDARD", - "REDUCED_REDUNDANCY" - ] - }, - "Suffix":{"type":"string"}, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"ObjectKey", - "documentation":"Name of the tag." - }, - "Value":{ - "shape":"Value", - "documentation":"Value of the tag." - } - } - }, - "TagSet":{ - "type":"list", - "member":{ - "shape":"Tag", - "locationName":"Tag" - } - }, - "Tagging":{ - "type":"structure", - "required":["TagSet"], - "members":{ - "TagSet":{"shape":"TagSet"} - } - }, - "TargetBucket":{"type":"string"}, - "TargetGrant":{ - "type":"structure", - "members":{ - "Grantee":{"shape":"Grantee"}, - "Permission":{ - "shape":"BucketLogsPermission", - "documentation":"Logging permissions assigned to the Grantee for the bucket." - } - } - }, - "TargetGrants":{ - "type":"list", - "member":{ - "shape":"TargetGrant", - "locationName":"Grant" - } - }, - "TargetPrefix":{"type":"string"}, - "Topic":{"type":"string"}, - "TopicConfiguration":{ - "type":"structure", - "members":{ - "Id":{"shape":"NotificationId"}, - "Events":{ - "shape":"Events", - "locationName":"Event" - }, - "Event":{ - "shape":"Event", - "deprecated":true, - "documentation":"Bucket event for which to send notifications." - }, - "Topic":{ - "shape":"Topic", - "documentation":"Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket." - } - } - }, - "Transition":{ - "type":"structure", - "members":{ - "Date":{ - "shape":"Date", - "documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." - }, - "Days":{ - "shape":"Days", - "documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." - }, - "StorageClass":{ - "shape":"TransitionStorageClass", - "documentation":"The class of storage used to store the object." - } - } - }, - "TransitionStorageClass":{ - "type":"string", - "enum":["GLACIER"] - }, - "Type":{ - "type":"string", - "enum":[ - "CanonicalUser", - "AmazonCustomerByEmail", - "Group" - ], - "xmlAttribute":true, - "locationName":"xsi:type" - }, - "URI":{"type":"string"}, - "UploadIdMarker":{"type":"string"}, - "UploadPartCopyOutput":{ - "type":"structure", - "members":{ - "CopySourceVersionId":{ - "shape":"CopySourceVersionId", - "location":"header", - "locationName":"x-amz-copy-source-version-id", - "documentation":"The version of the source object that was copied, if you have enabled versioning on the source bucket." - }, - "CopyPartResult":{"shape":"CopyPartResult"}, - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - }, - "payload":"CopyPartResult" - }, - "UploadPartCopyRequest":{ - "type":"structure", - "required":[ - "Bucket", - "CopySource", - "Key", - "PartNumber", - "UploadId" - ], - "members":{ - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "CopySource":{ - "shape":"CopySource", - "location":"header", - "locationName":"x-amz-copy-source", - "documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded." - }, - "CopySourceIfMatch":{ - "shape":"CopySourceIfMatch", - "location":"header", - "locationName":"x-amz-copy-source-if-match", - "documentation":"Copies the object if its entity tag (ETag) matches the specified tag." - }, - "CopySourceIfModifiedSince":{ - "shape":"CopySourceIfModifiedSince", - "location":"header", - "locationName":"x-amz-copy-source-if-modified-since", - "documentation":"Copies the object if it has been modified since the specified time." - }, - "CopySourceIfNoneMatch":{ - "shape":"CopySourceIfNoneMatch", - "location":"header", - "locationName":"x-amz-copy-source-if-none-match", - "documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag." - }, - "CopySourceIfUnmodifiedSince":{ - "shape":"CopySourceIfUnmodifiedSince", - "location":"header", - "locationName":"x-amz-copy-source-if-unmodified-since", - "documentation":"Copies the object if it hasn't been modified since the specified time." - }, - "CopySourceRange":{ - "shape":"CopySourceRange", - "location":"header", - "locationName":"x-amz-copy-source-range", - "documentation":"The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB." - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "PartNumber":{ - "shape":"PartNumber", - "location":"querystring", - "locationName":"partNumber", - "documentation":"Part number of part being copied." - }, - "UploadId":{ - "shape":"MultipartUploadId", - "location":"querystring", - "locationName":"uploadId", - "documentation":"Upload ID identifying the multipart upload whose part is being copied." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - }, - "CopySourceSSECustomerAlgorithm":{ - "shape":"CopySourceSSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256)." - }, - "CopySourceSSECustomerKey":{ - "shape":"CopySourceSSECustomerKey", - "location":"header", - "locationName":"x-amz-copy-source-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created." - }, - "CopySourceSSECustomerKeyMD5":{ - "shape":"CopySourceSSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - } - } - }, - "UploadPartOutput":{ - "type":"structure", - "members":{ - "ServerSideEncryption":{ - "shape":"ServerSideEncryption", - "location":"header", - "locationName":"x-amz-server-side-encryption", - "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." - }, - "ETag":{ - "shape":"ETag", - "location":"header", - "locationName":"ETag", - "documentation":"Entity tag for the uploaded object." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key." - }, - "SSEKMSKeyId":{ - "shape":"SSEKMSKeyId", - "location":"header", - "locationName":"x-amz-server-side-encryption-aws-kms-key-id", - "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." - } - } - }, - "UploadPartRequest":{ - "type":"structure", - "required":[ - "Bucket", - "Key", - "PartNumber", - "UploadId" - ], - "members":{ - "Body":{ - "shape":"Body", - "streaming":true - }, - "Bucket":{ - "shape":"BucketName", - "location":"uri", - "locationName":"Bucket" - }, - "ContentLength":{ - "shape":"ContentLength", - "location":"header", - "locationName":"Content-Length", - "documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." - }, - "ContentMD5":{ - "shape":"ContentMD5", - "location":"header", - "locationName":"Content-MD5" - }, - "Key":{ - "shape":"ObjectKey", - "location":"uri", - "locationName":"Key" - }, - "PartNumber":{ - "shape":"PartNumber", - "location":"querystring", - "locationName":"partNumber", - "documentation":"Part number of part being uploaded." - }, - "UploadId":{ - "shape":"MultipartUploadId", - "location":"querystring", - "locationName":"uploadId", - "documentation":"Upload ID identifying the multipart upload whose part is being uploaded." - }, - "SSECustomerAlgorithm":{ - "shape":"SSECustomerAlgorithm", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-algorithm", - "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256, aws:kms)." - }, - "SSECustomerKey":{ - "shape":"SSECustomerKey", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key", - "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request." - }, - "SSECustomerKeyMD5":{ - "shape":"SSECustomerKeyMD5", - "location":"header", - "locationName":"x-amz-server-side-encryption-customer-key-MD5", - "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." - } - }, - "payload":"Body" - }, - "Value":{"type":"string"}, - "VersionIdMarker":{"type":"string"}, - "VersioningConfiguration":{ - "type":"structure", - "members":{ - "MFADelete":{ - "shape":"MFADelete", - "documentation":"Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.", - "locationName":"MfaDelete" - }, - "Status":{ - "shape":"BucketVersioningStatus", - "documentation":"The versioning state of the bucket." - } - } - }, - "WebsiteConfiguration":{ - "type":"structure", - "members":{ - "ErrorDocument":{"shape":"ErrorDocument"}, - "IndexDocument":{"shape":"IndexDocument"}, - "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, - "RoutingRules":{"shape":"RoutingRules"} - } - }, - "WebsiteRedirectLocation":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.paginators.json deleted file mode 100644 index a966a78e20..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.paginators.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "pagination": { - "ListMultipartUploads": { - "limit_key": "MaxUploads", - "more_results": "IsTruncated", - "output_token": [ - "NextKeyMarker", - "NextUploadIdMarker" - ], - "input_token": [ - "KeyMarker", - "UploadIdMarker" - ], - "result_key": [ - "Uploads", - "CommonPrefixes" - ] - }, - "ListObjectVersions": { - "more_results": "IsTruncated", - "limit_key": "MaxKeys", - "output_token": [ - "NextKeyMarker", - "NextVersionIdMarker" - ], - "input_token": [ - "KeyMarker", - "VersionIdMarker" - ], - "result_key": [ - "Versions", - "DeleteMarkers", - "CommonPrefixes" - ] - }, - "ListObjects": { - "more_results": "IsTruncated", - "limit_key": "MaxKeys", - "output_token": "NextMarker || Contents[-1].Key", - "input_token": "Marker", - "result_key": [ - "Contents", - "CommonPrefixes" - ] - }, - "ListParts": { - "more_results": "IsTruncated", - "limit_key": "MaxParts", - "output_token": "NextPartNumberMarker", - "input_token": "PartNumberMarker", - "result_key": "Parts", - "non_aggregate_keys": [ - "Initiator", - "Owner", - "StorageClass" - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.waiters.json deleted file mode 100644 index 53bc2bc6ae..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/s3/2006-03-01.waiters.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "version": 2, - "waiters": { - "BucketExists": { - "delay": 5, - "operation": "HeadBucket", - "maxAttempts": 20, - "acceptors": [ - { - "expected": 200, - "matcher": "status", - "state": "success" - }, - { - "expected": 404, - "matcher": "status", - "state": "retry" - } - ] - }, - "BucketNotExists": { - "delay": 5, - "operation": "HeadBucket", - "maxAttempts": 20, - "acceptors": [ - { - "expected": 404, - "matcher": "status", - "state": "success" - } - ] - }, - "ObjectExists": { - "delay": 5, - "operation": "HeadObject", - "maxAttempts": 20, - "acceptors": [ - { - "expected": 200, - "matcher": "status", - "state": "success" - }, - { - "expected": 404, - "matcher": "status", - "state": "retry" - } - ] - }, - "ObjectNotExists": { - "delay": 5, - "operation": "HeadObject", - "maxAttempts": 20, - "acceptors": [ - { - "expected": 404, - "matcher": "status", - "state": "success" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/sdb/2009-04-15.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/sdb/2009-04-15.normal.json deleted file mode 100644 index 13c26ea266..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/sdb/2009-04-15.normal.json +++ /dev/null @@ -1,1178 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2009-04-15", - "endpointPrefix":"sdb", - "serviceFullName":"Amazon SimpleDB", - "signatureVersion":"v2", - "xmlNamespace":"http://sdb.amazonaws.com/doc/2009-04-15/", - "protocol":"query" - }, - "documentation":"Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development.A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use.
Visit http://aws.amazon.com/simpledb/ for more information.
", - "operations":{ - "BatchDeleteAttributes":{ - "name":"BatchDeleteAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"BatchDeleteAttributesRequest"}, - "documentation":"Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.
The following limitations are enforced for this operation:
The item name was specified more than once.
" - }, - { - "shape":"InvalidParameterValue", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"MissingParameter", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request must contain the specified missing parameter.
" - }, - { - "shape":"NoSuchDomain", - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - }, - { - "shape":"NumberItemAttributesExceeded", - "error":{ - "code":"NumberItemAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes in this item.
" - }, - { - "shape":"NumberDomainAttributesExceeded", - "error":{ - "code":"NumberDomainAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes in this domain.
" - }, - { - "shape":"NumberDomainBytesExceeded", - "error":{ - "code":"NumberDomainBytesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many bytes in this domain.
" - }, - { - "shape":"NumberSubmittedItemsExceeded", - "error":{ - "code":"NumberSubmittedItemsExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many items exist in a single call.
" - }, - { - "shape":"NumberSubmittedAttributesExceeded", - "error":{ - "code":"NumberSubmittedAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes exist in a single call.
" - } - ], - "documentation":" The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.
The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.
Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", \"second_value\" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same.
Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value.
Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.
The following limitations are enforced for this operation:
BatchPutAttributes operationThe value for a parameter is invalid.
" - }, - { - "shape":"MissingParameter", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request must contain the specified missing parameter.
" - }, - { - "shape":"NumberDomainsExceeded", - "error":{ - "code":"NumberDomainsExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many domains exist per this account.
" - } - ], - "documentation":" The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete.
The client can create up to 100 domains per account.
If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.
" - }, - "DeleteAttributes":{ - "name":"DeleteAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteAttributesRequest"}, - "errors":[ - { - "shape":"InvalidParameterValue", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"MissingParameter", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request must contain the specified missing parameter.
" - }, - { - "shape":"NoSuchDomain", - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - }, - { - "shape":"AttributeDoesNotExist", - "error":{ - "code":"AttributeDoesNotExist", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified attribute does not exist.
" - } - ], - "documentation":"Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.
DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.
The request must contain the specified missing parameter.
" - } - ], - "documentation":" The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.
The request must contain the specified missing parameter.
" - }, - { - "shape":"NoSuchDomain", - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - } - ], - "documentation":"Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.
" - }, - "GetAttributes":{ - "name":"GetAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetAttributesRequest"}, - "output":{ - "shape":"GetAttributesResult", - "resultWrapper":"GetAttributesResult" - }, - "errors":[ - { - "shape":"InvalidParameterValue", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"MissingParameter", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request must contain the specified missing parameter.
" - }, - { - "shape":"NoSuchDomain", - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - } - ], - "documentation":"Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter.
If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.
" - }, - "ListDomains":{ - "name":"ListDomains", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDomainsRequest"}, - "output":{ - "shape":"ListDomainsResult", - "resultWrapper":"ListDomainsResult" - }, - "errors":[ - { - "shape":"InvalidParameterValue", - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified NextToken is not valid.
" - } - ], - "documentation":" The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.
The value for a parameter is invalid.
" - }, - { - "shape":"MissingParameter", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request must contain the specified missing parameter.
" - }, - { - "shape":"NoSuchDomain", - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - }, - { - "shape":"NumberDomainAttributesExceeded", - "error":{ - "code":"NumberDomainAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes in this domain.
" - }, - { - "shape":"NumberDomainBytesExceeded", - "error":{ - "code":"NumberDomainBytesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many bytes in this domain.
" - }, - { - "shape":"NumberItemAttributesExceeded", - "error":{ - "code":"NumberItemAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes in this item.
" - }, - { - "shape":"AttributeDoesNotExist", - "error":{ - "code":"AttributeDoesNotExist", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified attribute does not exist.
" - } - ], - "documentation":" The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.
Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", second_value\" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same.
Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value.
You cannot specify an empty string as an attribute name.
Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data.
The following limitations are enforced for this operation:
The value for a parameter is invalid.
" - }, - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified NextToken is not valid.
" - }, - { - "shape":"InvalidNumberPredicates", - "error":{ - "code":"InvalidNumberPredicates", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Too many predicates exist in the query expression.
" - }, - { - "shape":"InvalidNumberValueTests", - "error":{ - "code":"InvalidNumberValueTests", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Too many predicates exist in the query expression.
" - }, - { - "shape":"InvalidQueryExpression", - "error":{ - "code":"InvalidQueryExpression", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified query expression syntax is not valid.
" - }, - { - "shape":"MissingParameter", - "error":{ - "code":"MissingParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request must contain the specified missing parameter.
" - }, - { - "shape":"NoSuchDomain", - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - }, - { - "shape":"RequestTimeout", - "error":{ - "code":"RequestTimeout", - "httpStatusCode":408, - "senderFault":true - }, - "exception":true, - "documentation":"A timeout occurred when attempting to query the specified domain with specified query expression.
" - }, - { - "shape":"TooManyRequestedAttributes", - "error":{ - "code":"TooManyRequestedAttributes", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes requested.
" - } - ], - "documentation":" The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.
The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results.
For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.
" - } - }, - "shapes":{ - "Attribute":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the attribute." - }, - "AlternateNameEncoding":{ - "shape":"String", - "documentation":"" - }, - "Value":{ - "shape":"String", - "documentation":"The value of the attribute." - }, - "AlternateValueEncoding":{ - "shape":"String", - "documentation":"" - } - }, - "documentation":"" - }, - "AttributeDoesNotExist":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"AttributeDoesNotExist", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"The specified attribute does not exist.
" - }, - "AttributeList":{ - "type":"list", - "member":{ - "shape":"Attribute", - "locationName":"Attribute" - }, - "flattened":true - }, - "AttributeNameList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"AttributeName" - }, - "flattened":true - }, - "BatchDeleteAttributesRequest":{ - "type":"structure", - "required":[ - "DomainName", - "Items" - ], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain in which the attributes are being deleted." - }, - "Items":{ - "shape":"DeletableItemList", - "documentation":"A list of items on which to perform the operation." - } - } - }, - "BatchPutAttributesRequest":{ - "type":"structure", - "required":[ - "DomainName", - "Items" - ], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain in which the attributes are being stored." - }, - "Items":{ - "shape":"ReplaceableItemList", - "documentation":"A list of items on which to perform the operation." - } - } - }, - "Boolean":{"type":"boolean"}, - "CreateDomainRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'." - } - } - }, - "DeletableItem":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "locationName":"ItemName" - }, - "Attributes":{"shape":"AttributeList"} - } - }, - "DeletableItemList":{ - "type":"list", - "member":{ - "shape":"DeletableItem", - "locationName":"Item" - }, - "flattened":true - }, - "DeleteAttributesRequest":{ - "type":"structure", - "required":[ - "DomainName", - "ItemName" - ], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain in which to perform the operation." - }, - "ItemName":{ - "shape":"String", - "documentation":"The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs." - }, - "Attributes":{ - "shape":"AttributeList", - "documentation":"A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items." - }, - "Expected":{ - "shape":"UpdateCondition", - "documentation":"The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted." - } - } - }, - "DeleteDomainRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain to delete." - } - } - }, - "DomainMetadataRequest":{ - "type":"structure", - "required":["DomainName"], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain for which to display the metadata of." - } - } - }, - "DomainMetadataResult":{ - "type":"structure", - "members":{ - "ItemCount":{ - "shape":"Integer", - "documentation":"The number of all items in the domain." - }, - "ItemNamesSizeBytes":{ - "shape":"Long", - "documentation":"The total size of all item names in the domain, in bytes." - }, - "AttributeNameCount":{ - "shape":"Integer", - "documentation":"The number of unique attribute names in the domain." - }, - "AttributeNamesSizeBytes":{ - "shape":"Long", - "documentation":"The total size of all unique attribute names in the domain, in bytes." - }, - "AttributeValueCount":{ - "shape":"Integer", - "documentation":"The number of all attribute name/value pairs in the domain." - }, - "AttributeValuesSizeBytes":{ - "shape":"Long", - "documentation":"The total size of all attribute values in the domain, in bytes." - }, - "Timestamp":{ - "shape":"Integer", - "documentation":"The data and time when metadata was calculated, in Epoch (UNIX) seconds." - } - } - }, - "DomainNameList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"DomainName" - }, - "flattened":true - }, - "DuplicateItemName":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"DuplicateItemName", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The item name was specified more than once.
" - }, - "Float":{"type":"float"}, - "GetAttributesRequest":{ - "type":"structure", - "required":[ - "DomainName", - "ItemName" - ], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain in which to perform the operation." - }, - "ItemName":{ - "shape":"String", - "documentation":"The name of the item." - }, - "AttributeNames":{ - "shape":"AttributeNameList", - "documentation":"The names of the attributes." - }, - "ConsistentRead":{ - "shape":"Boolean", - "documentation":"Determines whether or not strong consistency should be enforced when data is read from SimpleDB. Iftrue, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read."
- }
- }
- },
- "GetAttributesResult":{
- "type":"structure",
- "members":{
- "Attributes":{
- "shape":"AttributeList",
- "documentation":"The list of attributes returned by the operation."
- }
- }
- },
- "Integer":{"type":"integer"},
- "InvalidNextToken":{
- "type":"structure",
- "members":{
- "BoxUsage":{"shape":"Float"}
- },
- "error":{
- "code":"InvalidNextToken",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"The specified NextToken is not valid.
" - }, - "InvalidNumberPredicates":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"InvalidNumberPredicates", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Too many predicates exist in the query expression.
" - }, - "InvalidNumberValueTests":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"InvalidNumberValueTests", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Too many predicates exist in the query expression.
" - }, - "InvalidParameterValue":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"InvalidParameterValue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The value for a parameter is invalid.
" - }, - "InvalidQueryExpression":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"InvalidQueryExpression", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified query expression syntax is not valid.
" - }, - "Item":{ - "type":"structure", - "required":[ - "Name", - "Attributes" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the item." - }, - "AlternateNameEncoding":{ - "shape":"String", - "documentation":"" - }, - "Attributes":{ - "shape":"AttributeList", - "documentation":"A list of attributes." - } - }, - "documentation":"" - }, - "ItemList":{ - "type":"list", - "member":{ - "shape":"Item", - "locationName":"Item" - }, - "flattened":true - }, - "ListDomainsRequest":{ - "type":"structure", - "members":{ - "MaxNumberOfDomains":{ - "shape":"Integer", - "documentation":"The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100." - }, - "NextToken":{ - "shape":"String", - "documentation":"A string informing Amazon SimpleDB where to start the next list of domain names." - } - } - }, - "ListDomainsResult":{ - "type":"structure", - "members":{ - "DomainNames":{ - "shape":"DomainNameList", - "documentation":"A list of domain names that match the expression." - }, - "NextToken":{ - "shape":"String", - "documentation":"An opaque token indicating that there are more domains than the specifiedMaxNumberOfDomains still available."
- }
- }
- },
- "Long":{"type":"long"},
- "MissingParameter":{
- "type":"structure",
- "members":{
- "BoxUsage":{"shape":"Float"}
- },
- "error":{
- "code":"MissingParameter",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"The request must contain the specified missing parameter.
" - }, - "NoSuchDomain":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NoSuchDomain", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The specified domain does not exist.
" - }, - "NumberDomainAttributesExceeded":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NumberDomainAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes in this domain.
" - }, - "NumberDomainBytesExceeded":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NumberDomainBytesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many bytes in this domain.
" - }, - "NumberDomainsExceeded":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NumberDomainsExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many domains exist per this account.
" - }, - "NumberItemAttributesExceeded":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NumberItemAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes in this item.
" - }, - "NumberSubmittedAttributesExceeded":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NumberSubmittedAttributesExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many attributes exist in a single call.
" - }, - "NumberSubmittedItemsExceeded":{ - "type":"structure", - "members":{ - "BoxUsage":{"shape":"Float"} - }, - "error":{ - "code":"NumberSubmittedItemsExceeded", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Too many items exist in a single call.
" - }, - "PutAttributesRequest":{ - "type":"structure", - "required":[ - "DomainName", - "ItemName", - "Attributes" - ], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain in which to perform the operation." - }, - "ItemName":{ - "shape":"String", - "documentation":"The name of the item." - }, - "Attributes":{ - "shape":"ReplaceableAttributeList", - "documentation":"The list of attributes." - }, - "Expected":{ - "shape":"UpdateCondition", - "documentation":"The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated." - } - } - }, - "ReplaceableAttribute":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the replaceable attribute." - }, - "Value":{ - "shape":"String", - "documentation":"The value of the replaceable attribute." - }, - "Replace":{ - "shape":"Boolean", - "documentation":"A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting isfalse."
- }
- },
- "documentation":""
- },
- "ReplaceableAttributeList":{
- "type":"list",
- "member":{
- "shape":"ReplaceableAttribute",
- "locationName":"Attribute"
- },
- "flattened":true
- },
- "ReplaceableItem":{
- "type":"structure",
- "required":[
- "Name",
- "Attributes"
- ],
- "members":{
- "Name":{
- "shape":"String",
- "documentation":"The name of the replaceable item.",
- "locationName":"ItemName"
- },
- "Attributes":{
- "shape":"ReplaceableAttributeList",
- "documentation":"The list of attributes for a replaceable item."
- }
- },
- "documentation":""
- },
- "ReplaceableItemList":{
- "type":"list",
- "member":{
- "shape":"ReplaceableItem",
- "locationName":"Item"
- },
- "flattened":true
- },
- "RequestTimeout":{
- "type":"structure",
- "members":{
- "BoxUsage":{"shape":"Float"}
- },
- "error":{
- "code":"RequestTimeout",
- "httpStatusCode":408,
- "senderFault":true
- },
- "exception":true,
- "documentation":"A timeout occurred when attempting to query the specified domain with specified query expression.
" - }, - "SelectRequest":{ - "type":"structure", - "required":["SelectExpression"], - "members":{ - "SelectExpression":{ - "shape":"String", - "documentation":"The expression used to query the domain." - }, - "NextToken":{ - "shape":"String", - "documentation":"A string informing Amazon SimpleDB where to start the next list ofItemNames."
- },
- "ConsistentRead":{
- "shape":"Boolean",
- "documentation":"Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read."
- }
- }
- },
- "SelectResult":{
- "type":"structure",
- "members":{
- "Items":{
- "shape":"ItemList",
- "documentation":"A list of items that match the select expression."
- },
- "NextToken":{
- "shape":"String",
- "documentation":"An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds."
- }
- }
- },
- "String":{"type":"string"},
- "TooManyRequestedAttributes":{
- "type":"structure",
- "members":{
- "BoxUsage":{"shape":"Float"}
- },
- "error":{
- "code":"TooManyRequestedAttributes",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"Too many attributes requested.
" - }, - "UpdateCondition":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the attribute involved in the condition.
" - }, - "Value":{ - "shape":"String", - "documentation":"The value of an attribute. This value can only be specified when the Exists parameter is equal to true.
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.
Specifies the conditions under which data should be updated. If an update condition is specified for a request, the data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value exists, or if a specific attribute doesn't exist.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/sdb/2009-04-15.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/sdb/2009-04-15.paginators.json deleted file mode 100644 index 2362098870..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/sdb/2009-04-15.paginators.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "pagination": { - "ListDomains": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxNumberOfDomains", - "result_key": "DomainNames" - }, - "Select": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "Items" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.normal.json deleted file mode 100644 index b495cfa82f..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.normal.json +++ /dev/null @@ -1,954 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-12-01", - "endpointPrefix":"email", - "serviceAbbreviation":"Amazon SES", - "serviceFullName":"Amazon Simple Email Service", - "signatureVersion":"v4", - "signingName":"ses", - "xmlNamespace":"http://ses.amazonaws.com/doc/2010-12-01/", - "protocol":"query" - }, - "documentation":"This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.
", - "operations":{ - "DeleteIdentity":{ - "name":"DeleteIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteIdentityRequest", - "documentation":"Represents a request instructing the service to delete an identity from the list of identities for the AWS Account.
" - }, - "output":{ - "shape":"DeleteIdentityResponse", - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
", - "resultWrapper":"DeleteIdentityResult" - }, - "documentation":"Deletes the specified identity (email address or domain) from the list of verified identities.
This action is throttled at one request per second.
" - }, - "DeleteVerifiedEmailAddress":{ - "name":"DeleteVerifiedEmailAddress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteVerifiedEmailAddressRequest", - "documentation":"Represents a request instructing the service to delete an address from the list of verified email addresses.
" - }, - "documentation":"Deletes the specified email address from the list of verified addresses.
This action is throttled at one request per second.
" - }, - "GetIdentityDkimAttributes":{ - "name":"GetIdentityDkimAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetIdentityDkimAttributesRequest", - "documentation":"Given a list of verified identities, describes their DKIM attributes. The DKIM attributes of an email address identity includes whether DKIM signing is individually enabled or disabled for that address. The DKIM attributes of a domain name identity includes whether DKIM signing is enabled, as well as the DNS records (tokens) that must remain published in the domain name's DNS.
" - }, - "output":{ - "shape":"GetIdentityDkimAttributesResponse", - "documentation":"Represents a list of all the DKIM attributes for the specified identity.
", - "resultWrapper":"GetIdentityDkimAttributesResult" - }, - "documentation":"Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This action takes a list of identities as input and returns the following information for each:
This action is throttled at one request per second.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
" - }, - "GetIdentityNotificationAttributes":{ - "name":"GetIdentityNotificationAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetIdentityNotificationAttributesRequest"}, - "output":{ - "shape":"GetIdentityNotificationAttributesResponse", - "documentation":"Describes whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and specifies whether feedback forwarding is enabled for bounce and complaint notifications.
", - "resultWrapper":"GetIdentityNotificationAttributesResult" - }, - "documentation":"Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This action is throttled at one request per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
" - }, - "GetIdentityVerificationAttributes":{ - "name":"GetIdentityVerificationAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetIdentityVerificationAttributesRequest", - "documentation":"Represents a request instructing the service to provide the verification attributes for a list of identities.
" - }, - "output":{ - "shape":"GetIdentityVerificationAttributesResponse", - "documentation":"Represents the verification attributes for a list of identities.
", - "resultWrapper":"GetIdentityVerificationAttributesResult" - }, - "documentation":"Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
This action is throttled at one request per second.
" - }, - "GetSendQuota":{ - "name":"GetSendQuota", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetSendQuotaResponse", - "documentation":"Represents the user's current activity limits returned from a successful GetSendQuota request.
Returns the user's current sending limits.
This action is throttled at one request per second.
" - }, - "GetSendStatistics":{ - "name":"GetSendStatistics", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"GetSendStatisticsResponse", - "documentation":"Represents a list of SendDataPoint items returned from a successful GetSendStatistics request. This list contains aggregated data from the previous two weeks of sending activity.
Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.
Each data point in the list contains statistics for a 15-minute interval.
This action is throttled at one request per second.
" - }, - "ListIdentities":{ - "name":"ListIdentities", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListIdentitiesRequest", - "documentation":"Represents a request instructing the service to list all identities for the AWS Account.
" - }, - "output":{ - "shape":"ListIdentitiesResponse", - "documentation":"Represents a list of all verified identities for the AWS Account.
", - "resultWrapper":"ListIdentitiesResult" - }, - "documentation":"Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status.
This action is throttled at one request per second.
" - }, - "ListVerifiedEmailAddresses":{ - "name":"ListVerifiedEmailAddresses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"ListVerifiedEmailAddressesResponse", - "documentation":"Represents a list of all the email addresses verified for the current user.
", - "resultWrapper":"ListVerifiedEmailAddressesResult" - }, - "documentation":"Returns a list containing all of the email addresses that have been verified.
This action is throttled at one request per second.
" - }, - "SendEmail":{ - "name":"SendEmail", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SendEmailRequest", - "documentation":"Represents a request instructing the service to send a single email message.
This datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path parts. This object can then be sent using the SendEmail action.
Represents a unique message ID returned from a successful SendEmail request.
Composes an email message based on input data, and then immediately queues the message for sending.
The total size of the message cannot exceed 10 MB.
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.
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 Amazon SES Developer Guide.
" - }, - "SendRawEmail":{ - "name":"SendRawEmail", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SendRawEmailRequest", - "documentation":"Represents a request instructing the service to send a raw email message.
This datatype can be used in application code to compose a message consisting of source, destination, and raw message text. This object can then be sent using the SendRawEmail action.
Represents a unique message ID returned from a successful SendRawEmail request.
Sends an email message, with header and content specified by the client. The SendRawEmail 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.
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
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.
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.
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 Amazon SES Developer Guide.
" - }, - "SetIdentityDkimEnabled":{ - "name":"SetIdentityDkimEnabled", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetIdentityDkimEnabledRequest", - "documentation":"Represents a request instructing the service to enable or disable DKIM signing for an identity.
" - }, - "output":{ - "shape":"SetIdentityDkimEnabledResponse", - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
", - "resultWrapper":"SetIdentityDkimEnabledResult" - }, - "documentation":"Enables or disables Easy DKIM signing of email sent from an identity:
example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com).For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.
This action is throttled at one request per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
" - }, - "SetIdentityFeedbackForwardingEnabled":{ - "name":"SetIdentityFeedbackForwardingEnabled", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetIdentityFeedbackForwardingEnabledRequest"}, - "output":{ - "shape":"SetIdentityFeedbackForwardingEnabledResponse", - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
", - "resultWrapper":"SetIdentityFeedbackForwardingEnabledResult" - }, - "documentation":"Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
This action is throttled at one request per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
" - }, - "SetIdentityNotificationTopic":{ - "name":"SetIdentityNotificationTopic", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetIdentityNotificationTopicRequest", - "documentation":"Represents a request to set or clear an identity's notification topic.
" - }, - "output":{ - "shape":"SetIdentityNotificationTopicResponse", - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
", - "resultWrapper":"SetIdentityNotificationTopicResult" - }, - "documentation":"Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.
This action is throttled at one request per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
" - }, - "VerifyDomainDkim":{ - "name":"VerifyDomainDkim", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"VerifyDomainDkimRequest", - "documentation":"Represents a request instructing the service to begin DKIM verification for a domain.
" - }, - "output":{ - "shape":"VerifyDomainDkimResponse", - "documentation":"Represents the DNS records that must be published in the domain name's DNS to complete DKIM setup.
", - "resultWrapper":"VerifyDomainDkimResult" - }, - "documentation":"Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.
This action is throttled at one request per second.
To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
" - }, - "VerifyDomainIdentity":{ - "name":"VerifyDomainIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"VerifyDomainIdentityRequest", - "documentation":"Represents a request instructing the service to begin domain verification.
" - }, - "output":{ - "shape":"VerifyDomainIdentityResponse", - "documentation":"Represents a token used for domain ownership verification.
", - "resultWrapper":"VerifyDomainIdentityResult" - }, - "documentation":"Verifies a domain.
This action is throttled at one request per second.
" - }, - "VerifyEmailAddress":{ - "name":"VerifyEmailAddress", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"VerifyEmailAddressRequest", - "documentation":"Represents a request instructing the service to begin email address verification.
" - }, - "documentation":"Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
This action is throttled at one request per second.
" - }, - "VerifyEmailIdentity":{ - "name":"VerifyEmailIdentity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"VerifyEmailIdentityRequest", - "documentation":"Represents a request instructing the service to begin email address verification.
" - }, - "output":{ - "shape":"VerifyEmailIdentityResponse", - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
", - "resultWrapper":"VerifyEmailIdentityResult" - }, - "documentation":"Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
This action is throttled at one request per second.
" - } - }, - "shapes":{ - "Address":{"type":"string"}, - "AddressList":{ - "type":"list", - "member":{"shape":"Address"} - }, - "Body":{ - "type":"structure", - "members":{ - "Text":{ - "shape":"Content", - "documentation":"The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
" - }, - "Html":{ - "shape":"Content", - "documentation":"The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
" - } - }, - "documentation":"Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.
" - }, - "Charset":{"type":"string"}, - "Content":{ - "type":"structure", - "required":["Data"], - "members":{ - "Data":{ - "shape":"MessageData", - "documentation":"The textual data of the content.
" - }, - "Charset":{ - "shape":"Charset", - "documentation":"The character set of the content.
" - } - }, - "documentation":"Represents textual data, plus an optional character set specification.
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.
" - }, - "Counter":{"type":"long"}, - "DeleteIdentityRequest":{ - "type":"structure", - "required":["Identity"], - "members":{ - "Identity":{ - "shape":"Identity", - "documentation":"The identity to be removed from the list of identities for the AWS Account.
" - } - }, - "documentation":"Represents a request instructing the service to delete an identity from the list of identities for the AWS Account.
" - }, - "DeleteIdentityResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
" - }, - "DeleteVerifiedEmailAddressRequest":{ - "type":"structure", - "required":["EmailAddress"], - "members":{ - "EmailAddress":{ - "shape":"Address", - "documentation":"An email address to be removed from the list of verified addresses.
" - } - }, - "documentation":"Represents a request instructing the service to delete an address from the list of verified email addresses.
" - }, - "Destination":{ - "type":"structure", - "members":{ - "ToAddresses":{ - "shape":"AddressList", - "documentation":"The To: field(s) of the message.
" - }, - "CcAddresses":{ - "shape":"AddressList", - "documentation":"The CC: field(s) of the message.
" - }, - "BccAddresses":{ - "shape":"AddressList", - "documentation":"The BCC: field(s) of the message.
" - } - }, - "documentation":"Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
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: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.
A list of one or more verified identities - email addresses, domains, or both.
" - } - }, - "documentation":"Given a list of verified identities, describes their DKIM attributes. The DKIM attributes of an email address identity includes whether DKIM signing is individually enabled or disabled for that address. The DKIM attributes of a domain name identity includes whether DKIM signing is enabled, as well as the DNS records (tokens) that must remain published in the domain name's DNS.
" - }, - "GetIdentityDkimAttributesResponse":{ - "type":"structure", - "required":["DkimAttributes"], - "members":{ - "DkimAttributes":{ - "shape":"DkimAttributes", - "documentation":"The DKIM attributes for an email address or a domain.
" - } - }, - "documentation":"Represents a list of all the DKIM attributes for the specified identity.
" - }, - "GetIdentityNotificationAttributesRequest":{ - "type":"structure", - "required":["Identities"], - "members":{ - "Identities":{ - "shape":"IdentityList", - "documentation":"A list of one or more identities.
" - } - } - }, - "GetIdentityNotificationAttributesResponse":{ - "type":"structure", - "required":["NotificationAttributes"], - "members":{ - "NotificationAttributes":{ - "shape":"NotificationAttributes", - "documentation":"A map of Identity to IdentityNotificationAttributes.
" - } - }, - "documentation":"Describes whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and specifies whether feedback forwarding is enabled for bounce and complaint notifications.
" - }, - "GetIdentityVerificationAttributesRequest":{ - "type":"structure", - "required":["Identities"], - "members":{ - "Identities":{ - "shape":"IdentityList", - "documentation":"A list of identities.
" - } - }, - "documentation":"Represents a request instructing the service to provide the verification attributes for a list of identities.
" - }, - "GetIdentityVerificationAttributesResponse":{ - "type":"structure", - "required":["VerificationAttributes"], - "members":{ - "VerificationAttributes":{ - "shape":"VerificationAttributes", - "documentation":"A map of Identities to IdentityVerificationAttributes objects.
" - } - }, - "documentation":"Represents the verification attributes for a list of identities.
" - }, - "GetSendQuotaResponse":{ - "type":"structure", - "members":{ - "Max24HourSend":{ - "shape":"Max24HourSend", - "documentation":"The maximum number of emails the user is allowed to send in a 24-hour interval.
" - }, - "MaxSendRate":{ - "shape":"MaxSendRate", - "documentation":"The maximum number of emails the user is allowed to send per second.
" - }, - "SentLast24Hours":{ - "shape":"SentLast24Hours", - "documentation":"The number of emails sent during the previous 24 hours.
" - } - }, - "documentation":"Represents the user's current activity limits returned from a successful GetSendQuota request.
A list of data points, each of which represents 15 minutes of activity.
" - } - }, - "documentation":"Represents a list of SendDataPoint items returned from a successful GetSendStatistics request. This list contains aggregated data from the previous two weeks of sending activity.
True if DKIM signing is enabled for email sent from the identity; false otherwise.
" - }, - "DkimVerificationStatus":{ - "shape":"VerificationStatus", - "documentation":"Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
" - }, - "DkimTokens":{ - "shape":"VerificationTokenList", - "documentation":"A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
" - } - }, - "documentation":"Represents the DKIM attributes of a verified email address or a domain.
" - }, - "IdentityList":{ - "type":"list", - "member":{"shape":"Identity"} - }, - "IdentityNotificationAttributes":{ - "type":"structure", - "required":[ - "BounceTopic", - "ComplaintTopic", - "DeliveryTopic", - "ForwardingEnabled" - ], - "members":{ - "BounceTopic":{ - "shape":"NotificationTopic", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
" - }, - "ComplaintTopic":{ - "shape":"NotificationTopic", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
" - }, - "DeliveryTopic":{ - "shape":"NotificationTopic", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
" - }, - "ForwardingEnabled":{ - "shape":"Enabled", - "documentation":"Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.
Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.
" - }, - "IdentityType":{ - "type":"string", - "enum":[ - "EmailAddress", - "Domain" - ] - }, - "IdentityVerificationAttributes":{ - "type":"structure", - "required":["VerificationStatus"], - "members":{ - "VerificationStatus":{ - "shape":"VerificationStatus", - "documentation":"The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".
" - }, - "VerificationToken":{ - "shape":"VerificationToken", - "documentation":"The verification token for a domain identity. Null for email address identities.
" - } - }, - "documentation":"Represents the verification attributes of a single identity.
" - }, - "ListIdentitiesRequest":{ - "type":"structure", - "members":{ - "IdentityType":{ - "shape":"IdentityType", - "documentation":"The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The token to use for pagination.
" - }, - "MaxItems":{ - "shape":"MaxItems", - "documentation":"The maximum number of identities per page. Possible values are 1-100 inclusive.
" - } - }, - "documentation":"Represents a request instructing the service to list all identities for the AWS Account.
" - }, - "ListIdentitiesResponse":{ - "type":"structure", - "required":["Identities"], - "members":{ - "Identities":{ - "shape":"IdentityList", - "documentation":"A list of identities.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The token used for pagination.
" - } - }, - "documentation":"Represents a list of all verified identities for the AWS Account.
" - }, - "ListVerifiedEmailAddressesResponse":{ - "type":"structure", - "members":{ - "VerifiedEmailAddresses":{ - "shape":"AddressList", - "documentation":"A list of email addresses that have been verified.
" - } - }, - "documentation":"Represents a list of all the email addresses verified for the current user.
" - }, - "Max24HourSend":{"type":"double"}, - "MaxItems":{"type":"integer"}, - "MaxSendRate":{"type":"double"}, - "Message":{ - "type":"structure", - "required":[ - "Subject", - "Body" - ], - "members":{ - "Subject":{ - "shape":"Content", - "documentation":"The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
" - }, - "Body":{ - "shape":"Body", - "documentation":"The message body.
" - } - }, - "documentation":"Represents the message to be sent, composed of a subject and a body.
" - }, - "MessageData":{"type":"string"}, - "MessageId":{"type":"string"}, - "MessageRejected":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"MessageRejected", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error." - }, - "NextToken":{"type":"string"}, - "NotificationAttributes":{ - "type":"map", - "key":{"shape":"Identity"}, - "value":{"shape":"IdentityNotificationAttributes"} - }, - "NotificationTopic":{"type":"string"}, - "NotificationType":{ - "type":"string", - "enum":[ - "Bounce", - "Complaint", - "Delivery" - ] - }, - "RawMessage":{ - "type":"structure", - "required":["Data"], - "members":{ - "Data":{ - "shape":"RawMessageData", - "documentation":"The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).
The To:, CC:, and BCC: headers in the raw message can contain a group list.
For more information, go to the Amazon SES Developer Guide.
" - } - }, - "documentation":"Represents the raw data of the message.
" - }, - "RawMessageData":{"type":"blob"}, - "SendDataPoint":{ - "type":"structure", - "members":{ - "Timestamp":{ - "shape":"Timestamp", - "documentation":"Time of the data point.
" - }, - "DeliveryAttempts":{ - "shape":"Counter", - "documentation":"Number of emails that have been enqueued for sending.
" - }, - "Bounces":{ - "shape":"Counter", - "documentation":"Number of emails that have bounced.
" - }, - "Complaints":{ - "shape":"Counter", - "documentation":"Number of unwanted emails that were rejected by recipients.
" - }, - "Rejects":{ - "shape":"Counter", - "documentation":"Number of emails rejected by Amazon SES.
" - } - }, - "documentation":"Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.
The identity's email address.
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: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.
The destination for this email, composed of To:, CC:, and BCC: fields.
" - }, - "Message":{ - "shape":"Message", - "documentation":"The message to be sent.
" - }, - "ReplyToAddresses":{ - "shape":"AddressList", - "documentation":"The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
" - }, - "ReturnPath":{ - "shape":"Address", - "documentation":"The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter.
Represents a request instructing the service to send a single email message.
This datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path parts. This object can then be sent using the SendEmail action.
The unique message identifier returned from the SendEmail action.
Represents a unique message ID returned from a successful SendEmail request.
The identity's email address.
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: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
" - }, - "RawMessage":{ - "shape":"RawMessage", - "documentation":"The raw text of the message. The client is responsible for ensuring the following:
Represents a request instructing the service to send a raw email message.
This datatype can be used in application code to compose a message consisting of source, destination, and raw message text. This object can then be sent using the SendRawEmail action.
The unique message identifier returned from the SendRawEmail action.
Represents a unique message ID returned from a successful SendRawEmail request.
The identity for which DKIM signing should be enabled or disabled.
" - }, - "DkimEnabled":{ - "shape":"Enabled", - "documentation":"Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
Represents a request instructing the service to enable or disable DKIM signing for an identity.
" - }, - "SetIdentityDkimEnabledResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
" - }, - "SetIdentityFeedbackForwardingEnabledRequest":{ - "type":"structure", - "required":[ - "Identity", - "ForwardingEnabled" - ], - "members":{ - "Identity":{ - "shape":"Identity", - "documentation":"The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.
Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
An empty element. Receiving this element indicates that the request completed successfully.
" - }, - "SetIdentityNotificationTopicRequest":{ - "type":"structure", - "required":[ - "Identity", - "NotificationType" - ], - "members":{ - "Identity":{ - "shape":"Identity", - "documentation":"The identity for which the Amazon SNS topic will be set. Examples: user@example.com, example.com.
The type of notifications that will be published to the specified Amazon SNS topic.
" - }, - "SnsTopic":{ - "shape":"NotificationTopic", - "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.
Represents a request to set or clear an identity's notification topic.
" - }, - "SetIdentityNotificationTopicResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
" - }, - "Timestamp":{"type":"timestamp"}, - "VerificationAttributes":{ - "type":"map", - "key":{"shape":"Identity"}, - "value":{"shape":"IdentityVerificationAttributes"} - }, - "VerificationStatus":{ - "type":"string", - "enum":[ - "Pending", - "Success", - "Failed", - "TemporaryFailure", - "NotStarted" - ] - }, - "VerificationToken":{"type":"string"}, - "VerificationTokenList":{ - "type":"list", - "member":{"shape":"VerificationToken"} - }, - "VerifyDomainDkimRequest":{ - "type":"structure", - "required":["Domain"], - "members":{ - "Domain":{ - "shape":"Domain", - "documentation":"The name of the domain to be verified for Easy DKIM signing.
" - } - }, - "documentation":"Represents a request instructing the service to begin DKIM verification for a domain.
" - }, - "VerifyDomainDkimResponse":{ - "type":"structure", - "required":["DkimTokens"], - "members":{ - "DkimTokens":{ - "shape":"VerificationTokenList", - "documentation":"A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
" - } - }, - "documentation":"Represents the DNS records that must be published in the domain name's DNS to complete DKIM setup.
" - }, - "VerifyDomainIdentityRequest":{ - "type":"structure", - "required":["Domain"], - "members":{ - "Domain":{ - "shape":"Domain", - "documentation":"The domain to be verified.
" - } - }, - "documentation":"Represents a request instructing the service to begin domain verification.
" - }, - "VerifyDomainIdentityResponse":{ - "type":"structure", - "required":["VerificationToken"], - "members":{ - "VerificationToken":{ - "shape":"VerificationToken", - "documentation":"A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.
" - } - }, - "documentation":"Represents a token used for domain ownership verification.
" - }, - "VerifyEmailAddressRequest":{ - "type":"structure", - "required":["EmailAddress"], - "members":{ - "EmailAddress":{ - "shape":"Address", - "documentation":"The email address to be verified.
" - } - }, - "documentation":"Represents a request instructing the service to begin email address verification.
" - }, - "VerifyEmailIdentityRequest":{ - "type":"structure", - "required":["EmailAddress"], - "members":{ - "EmailAddress":{ - "shape":"Address", - "documentation":"The email address to be verified.
" - } - }, - "documentation":"Represents a request instructing the service to begin email address verification.
" - }, - "VerifyEmailIdentityResponse":{ - "type":"structure", - "members":{ - }, - "documentation":"An empty element. Receiving this element indicates that the request completed successfully.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.paginators.json deleted file mode 100644 index af0e93d184..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.paginators.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "pagination": { - "ListIdentities": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxItems", - "result_key": "Identities" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.waiters.json b/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.waiters.json deleted file mode 100644 index b585d309ef..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/ses/2010-12-01.waiters.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "version": 2, - "waiters": { - "IdentityExists": { - "delay": 3, - "operation": "GetIdentityVerificationAttributes", - "maxAttempts": 20, - "acceptors": [ - { - "expected": "Success", - "matcher": "pathAll", - "state": "success", - "argument": "VerificationAttributes.*.VerificationStatus" - } - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/sns/2010-03-31.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/sns/2010-03-31.normal.json deleted file mode 100644 index cefb50bbee..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/sns/2010-03-31.normal.json +++ /dev/null @@ -1,2275 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2010-03-31", - "endpointPrefix":"sns", - "serviceAbbreviation":"Amazon SNS", - "serviceFullName":"Amazon Simple Notification Service", - "signatureVersion":"v4", - "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/", - "protocol":"query" - }, - "documentation":"Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
", - "operations":{ - "AddPermission":{ - "name":"AddPermission", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddPermissionInput"}, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
" - }, - "ConfirmSubscription":{ - "name":"ConfirmSubscription", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ConfirmSubscriptionInput", - "documentation":"Input for ConfirmSubscription action." - }, - "output":{ - "shape":"ConfirmSubscriptionResponse", - "documentation":"Response for ConfirmSubscriptions action.", - "resultWrapper":"ConfirmSubscriptionResult" - }, - "errors":[ - { - "shape":"SubscriptionLimitExceededException", - "error":{ - "code":"SubscriptionLimitExceeded", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the customer already owns the maximum allowed number of subscriptions.
" - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".
Input for CreatePlatformApplication action.
" - }, - "output":{ - "shape":"CreatePlatformApplicationResponse", - "documentation":"Response from CreatePlatformApplication action.
", - "resultWrapper":"CreatePlatformApplicationResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications.
Input for CreatePlatformEndpoint action.
" - }, - "output":{ - "shape":"CreateEndpointResponse", - "documentation":"Response from CreateEndpoint action.
", - "resultWrapper":"CreatePlatformEndpointResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
Input for CreateTopic action.
" - }, - "output":{ - "shape":"CreateTopicResponse", - "documentation":"Response from CreateTopic action.
", - "resultWrapper":"CreateTopicResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"TopicLimitExceededException", - "error":{ - "code":"TopicLimitExceeded", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the customer already owns the maximum allowed number of topics.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
" - }, - "DeleteEndpoint":{ - "name":"DeleteEndpoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteEndpointInput", - "documentation":"Input for DeleteEndpoint action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
" - }, - "DeletePlatformApplication":{ - "name":"DeletePlatformApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeletePlatformApplicationInput", - "documentation":"Input for DeletePlatformApplication action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
" - }, - "DeleteTopic":{ - "name":"DeleteTopic", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteTopicInput"}, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
" - }, - "GetEndpointAttributes":{ - "name":"GetEndpointAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetEndpointAttributesInput", - "documentation":"Input for GetEndpointAttributes action.
" - }, - "output":{ - "shape":"GetEndpointAttributesResponse", - "documentation":"Response from GetEndpointAttributes of the EndpointArn.
", - "resultWrapper":"GetEndpointAttributesResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
" - }, - "GetPlatformApplicationAttributes":{ - "name":"GetPlatformApplicationAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetPlatformApplicationAttributesInput", - "documentation":"Input for GetPlatformApplicationAttributes action.
" - }, - "output":{ - "shape":"GetPlatformApplicationAttributesResponse", - "documentation":"Response for GetPlatformApplicationAttributes action.
", - "resultWrapper":"GetPlatformApplicationAttributesResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
" - }, - "GetSubscriptionAttributes":{ - "name":"GetSubscriptionAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetSubscriptionAttributesInput", - "documentation":"Input for GetSubscriptionAttributes.
" - }, - "output":{ - "shape":"GetSubscriptionAttributesResponse", - "documentation":"Response for GetSubscriptionAttributes action.
", - "resultWrapper":"GetSubscriptionAttributesResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Returns all of the properties of a subscription.
" - }, - "GetTopicAttributes":{ - "name":"GetTopicAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"GetTopicAttributesInput", - "documentation":"Input for GetTopicAttributes action.
" - }, - "output":{ - "shape":"GetTopicAttributesResponse", - "documentation":"Response for GetTopicAttributes action.
", - "resultWrapper":"GetTopicAttributesResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
" - }, - "ListEndpointsByPlatformApplication":{ - "name":"ListEndpointsByPlatformApplication", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListEndpointsByPlatformApplicationInput", - "documentation":"Input for ListEndpointsByPlatformApplication action.
" - }, - "output":{ - "shape":"ListEndpointsByPlatformApplicationResponse", - "documentation":"Response for ListEndpointsByPlatformApplication action.
", - "resultWrapper":"ListEndpointsByPlatformApplicationResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
Input for ListPlatformApplications action.
" - }, - "output":{ - "shape":"ListPlatformApplicationsResponse", - "documentation":"Response for ListPlatformApplications action.
", - "resultWrapper":"ListPlatformApplicationsResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
Response for ListSubscriptions action
", - "resultWrapper":"ListSubscriptionsResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
Input for ListSubscriptionsByTopic action.
" - }, - "output":{ - "shape":"ListSubscriptionsByTopicResponse", - "documentation":"Response for ListSubscriptionsByTopic action.
", - "resultWrapper":"ListSubscriptionsByTopicResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
Response for ListTopics action.
", - "resultWrapper":"ListTopicsResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
Input for Publish action.
" - }, - "output":{ - "shape":"PublishResponse", - "documentation":"Response for Publish action.
", - "resultWrapper":"PublishResult" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InvalidParameterValueException", - "error":{ - "code":"ParameterValueInvalid", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"EndpointDisabledException", - "error":{ - "code":"EndpointDisabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Exception error indicating endpoint disabled.
" - }, - { - "shape":"PlatformApplicationDisabledException", - "error":{ - "code":"PlatformApplicationDisabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Exception error indicating platform application disabled.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.
Input for RemovePermission action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Removes a statement from a topic's access control policy.
" - }, - "SetEndpointAttributes":{ - "name":"SetEndpointAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetEndpointAttributesInput", - "documentation":"Input for SetEndpointAttributes action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
" - }, - "SetPlatformApplicationAttributes":{ - "name":"SetPlatformApplicationAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetPlatformApplicationAttributesInput", - "documentation":"Input for SetPlatformApplicationAttributes action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
" - }, - "SetSubscriptionAttributes":{ - "name":"SetSubscriptionAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetSubscriptionAttributesInput", - "documentation":"Input for SetSubscriptionAttributes action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Allows a subscription owner to set an attribute of the topic to a new value.
" - }, - "SetTopicAttributes":{ - "name":"SetTopicAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetTopicAttributesInput", - "documentation":"Input for SetTopicAttributes action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Allows a topic owner to set an attribute of the topic to a new value.
" - }, - "Subscribe":{ - "name":"Subscribe", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SubscribeInput", - "documentation":"Input for Subscribe action." - }, - "output":{ - "shape":"SubscribeResponse", - "documentation":"Response for Subscribe action.", - "resultWrapper":"SubscribeResult" - }, - "errors":[ - { - "shape":"SubscriptionLimitExceededException", - "error":{ - "code":"SubscriptionLimitExceeded", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the customer already owns the maximum allowed number of subscriptions.
" - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - } - ], - "documentation":"Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
Input for Unsubscribe action.
" - }, - "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - { - "shape":"AuthorizationErrorException", - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - { - "shape":"NotFoundException", - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - } - ], - "documentation":"Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
The ARN of the topic whose access control policy you wish to modify.
" - }, - "Label":{ - "shape":"label", - "documentation":"A unique identifier for the new policy statement.
" - }, - "AWSAccountId":{ - "shape":"DelegatesList", - "documentation":"The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
" - }, - "ActionName":{ - "shape":"ActionsList", - "documentation":"The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
" - } - } - }, - "AuthorizationErrorException":{ - "type":"structure", - "members":{ - "message":{"shape":"string"} - }, - "error":{ - "code":"AuthorizationError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the user has been denied access to the requested resource.
" - }, - "Binary":{"type":"blob"}, - "ConfirmSubscriptionInput":{ - "type":"structure", - "required":[ - "TopicArn", - "Token" - ], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic for which you wish to confirm a subscription.
" - }, - "Token":{ - "shape":"token", - "documentation":"Short-lived token sent to an endpoint during the Subscribe action.
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
The ARN of the created subscription.
" - } - }, - "documentation":"Response for ConfirmSubscriptions action." - }, - "CreateEndpointResponse":{ - "type":"structure", - "members":{ - "EndpointArn":{ - "shape":"String", - "documentation":"EndpointArn returned from CreateEndpoint action.
" - } - }, - "documentation":"Response from CreateEndpoint action.
" - }, - "CreatePlatformApplicationInput":{ - "type":"structure", - "required":[ - "Name", - "Platform", - "Attributes" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
" - }, - "Platform":{ - "shape":"String", - "documentation":"The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
" - }, - "Attributes":{ - "shape":"MapStringToString", - "documentation":"For a list of attributes, see SetPlatformApplicationAttributes
" - } - }, - "documentation":"Input for CreatePlatformApplication action.
" - }, - "CreatePlatformApplicationResponse":{ - "type":"structure", - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn is returned.
" - } - }, - "documentation":"Response from CreatePlatformApplication action.
" - }, - "CreatePlatformEndpointInput":{ - "type":"structure", - "required":[ - "PlatformApplicationArn", - "Token" - ], - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
" - }, - "Token":{ - "shape":"String", - "documentation":"Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
" - }, - "CustomUserData":{ - "shape":"String", - "documentation":"Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
" - }, - "Attributes":{ - "shape":"MapStringToString", - "documentation":"For a list of attributes, see SetEndpointAttributes.
" - } - }, - "documentation":"Input for CreatePlatformEndpoint action.
" - }, - "CreateTopicInput":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"topicName", - "documentation":"The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
" - } - }, - "documentation":"Input for CreateTopic action.
" - }, - "CreateTopicResponse":{ - "type":"structure", - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The Amazon Resource Name (ARN) assigned to the created topic.
" - } - }, - "documentation":"Response from CreateTopic action.
" - }, - "DelegatesList":{ - "type":"list", - "member":{"shape":"delegate"} - }, - "DeleteEndpointInput":{ - "type":"structure", - "required":["EndpointArn"], - "members":{ - "EndpointArn":{ - "shape":"String", - "documentation":"EndpointArn of endpoint to delete.
" - } - }, - "documentation":"Input for DeleteEndpoint action.
" - }, - "DeletePlatformApplicationInput":{ - "type":"structure", - "required":["PlatformApplicationArn"], - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn of platform application object to delete.
" - } - }, - "documentation":"Input for DeletePlatformApplication action.
" - }, - "DeleteTopicInput":{ - "type":"structure", - "required":["TopicArn"], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic you want to delete.
" - } - } - }, - "Endpoint":{ - "type":"structure", - "members":{ - "EndpointArn":{ - "shape":"String", - "documentation":"EndpointArn for mobile app and device.
" - }, - "Attributes":{ - "shape":"MapStringToString", - "documentation":"Attributes for endpoint.
" - } - }, - "documentation":"Endpoint for mobile app and device.
" - }, - "EndpointDisabledException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"string", - "documentation":"Message for endpoint disabled.
" - } - }, - "error":{ - "code":"EndpointDisabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Exception error indicating endpoint disabled.
" - }, - "GetEndpointAttributesInput":{ - "type":"structure", - "required":["EndpointArn"], - "members":{ - "EndpointArn":{ - "shape":"String", - "documentation":"EndpointArn for GetEndpointAttributes input.
" - } - }, - "documentation":"Input for GetEndpointAttributes action.
" - }, - "GetEndpointAttributesResponse":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"MapStringToString", - "documentation":"Attributes include the following:
CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.Response from GetEndpointAttributes of the EndpointArn.
" - }, - "GetPlatformApplicationAttributesInput":{ - "type":"structure", - "required":["PlatformApplicationArn"], - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn for GetPlatformApplicationAttributesInput.
" - } - }, - "documentation":"Input for GetPlatformApplicationAttributes action.
" - }, - "GetPlatformApplicationAttributesResponse":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"MapStringToString", - "documentation":"Attributes include the following:
EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.Response for GetPlatformApplicationAttributes action.
" - }, - "GetSubscriptionAttributesInput":{ - "type":"structure", - "required":["SubscriptionArn"], - "members":{ - "SubscriptionArn":{ - "shape":"subscriptionARN", - "documentation":"The ARN of the subscription whose properties you want to get.
" - } - }, - "documentation":"Input for GetSubscriptionAttributes.
" - }, - "GetSubscriptionAttributesResponse":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"SubscriptionAttributesMap", - "documentation":"A map of the subscription's attributes. Attributes in this map include the following:
SubscriptionArn -- the subscription's ARNTopicArn -- the topic ARN that the subscription is associated withOwner -- the AWS account ID of the subscription's ownerConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticatedDeliveryPolicy -- the JSON serialization of the subscription's delivery policyEffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaultsResponse for GetSubscriptionAttributes action.
" - }, - "GetTopicAttributesInput":{ - "type":"structure", - "required":["TopicArn"], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic whose properties you want to get.
" - } - }, - "documentation":"Input for GetTopicAttributes action.
" - }, - "GetTopicAttributesResponse":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"TopicAttributesMap", - "documentation":"A map of the topic's attributes. Attributes in this map include the following:
TopicArn -- the topic's ARNOwner -- the AWS account ID of the topic's ownerPolicy -- the JSON serialization of the topic's access control policyDisplayName -- the human-readable name used in the \"From\" field for notifications to email and email-json endpointsSubscriptionsPending -- the number of subscriptions pending confirmation on this topicSubscriptionsConfirmed -- the number of confirmed subscriptions on this topicSubscriptionsDeleted -- the number of deleted subscriptions on this topicDeliveryPolicy -- the JSON serialization of the topic's delivery policyEffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account system defaultsResponse for GetTopicAttributes action.
" - }, - "InternalErrorException":{ - "type":"structure", - "members":{ - "message":{"shape":"string"} - }, - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error.
" - }, - "InvalidParameterException":{ - "type":"structure", - "members":{ - "message":{"shape":"string"} - }, - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - "InvalidParameterValueException":{ - "type":"structure", - "members":{ - "message":{"shape":"string"} - }, - "error":{ - "code":"ParameterValueInvalid", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that a request parameter does not comply with the associated constraints.
" - }, - "ListEndpointsByPlatformApplicationInput":{ - "type":"structure", - "required":["PlatformApplicationArn"], - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
" - }, - "NextToken":{ - "shape":"String", - "documentation":"NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
" - } - }, - "documentation":"Input for ListEndpointsByPlatformApplication action.
" - }, - "ListEndpointsByPlatformApplicationResponse":{ - "type":"structure", - "members":{ - "Endpoints":{ - "shape":"ListOfEndpoints", - "documentation":"Endpoints returned for ListEndpointsByPlatformApplication action.
" - }, - "NextToken":{ - "shape":"String", - "documentation":"NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
" - } - }, - "documentation":"Response for ListEndpointsByPlatformApplication action.
" - }, - "ListOfEndpoints":{ - "type":"list", - "member":{"shape":"Endpoint"} - }, - "ListOfPlatformApplications":{ - "type":"list", - "member":{"shape":"PlatformApplication"} - }, - "ListPlatformApplicationsInput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"String", - "documentation":"NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
" - } - }, - "documentation":"Input for ListPlatformApplications action.
" - }, - "ListPlatformApplicationsResponse":{ - "type":"structure", - "members":{ - "PlatformApplications":{ - "shape":"ListOfPlatformApplications", - "documentation":"Platform applications returned when calling ListPlatformApplications action.
" - }, - "NextToken":{ - "shape":"String", - "documentation":"NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
" - } - }, - "documentation":"Response for ListPlatformApplications action.
" - }, - "ListSubscriptionsByTopicInput":{ - "type":"structure", - "required":["TopicArn"], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic for which you wish to find subscriptions.
" - }, - "NextToken":{ - "shape":"nextToken", - "documentation":"Token returned by the previous ListSubscriptionsByTopic request.
Input for ListSubscriptionsByTopic action.
" - }, - "ListSubscriptionsByTopicResponse":{ - "type":"structure", - "members":{ - "Subscriptions":{ - "shape":"SubscriptionsList", - "documentation":"A list of subscriptions.
" - }, - "NextToken":{ - "shape":"nextToken", - "documentation":"Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.
Response for ListSubscriptionsByTopic action.
" - }, - "ListSubscriptionsInput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"nextToken", - "documentation":"Token returned by the previous ListSubscriptions request.
A list of subscriptions.
" - }, - "NextToken":{ - "shape":"nextToken", - "documentation":"Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
Response for ListSubscriptions action
" - }, - "ListTopicsInput":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"nextToken", - "documentation":"Token returned by the previous ListTopics request.
A list of topic ARNs.
" - }, - "NextToken":{ - "shape":"nextToken", - "documentation":"Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
Response for ListTopics action.
" - }, - "MapStringToString":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "MessageAttributeMap":{ - "type":"map", - "key":{ - "shape":"String", - "locationName":"Name" - }, - "value":{ - "shape":"MessageAttributeValue", - "locationName":"Value" - } - }, - "MessageAttributeValue":{ - "type":"structure", - "required":["DataType"], - "members":{ - "DataType":{ - "shape":"String", - "documentation":"Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
" - }, - "StringValue":{ - "shape":"String", - "documentation":"Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
" - }, - "BinaryValue":{ - "shape":"Binary", - "documentation":"Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
" - } - }, - "documentation":"The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.
" - }, - "NotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"string"} - }, - "error":{ - "code":"NotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the requested resource does not exist.
" - }, - "PlatformApplication":{ - "type":"structure", - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn for platform application object.
" - }, - "Attributes":{ - "shape":"MapStringToString", - "documentation":"Attributes for platform application object.
" - } - }, - "documentation":"Platform application object.
" - }, - "PlatformApplicationDisabledException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"string", - "documentation":"Message for platform application disabled.
" - } - }, - "error":{ - "code":"PlatformApplicationDisabled", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Exception error indicating platform application disabled.
" - }, - "PublishInput":{ - "type":"structure", - "required":["Message"], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The topic you want to publish to.
" - }, - "TargetArn":{ - "shape":"String", - "documentation":"Either TopicArn or EndpointArn, but not both.
" - }, - "Message":{ - "shape":"message", - "documentation":"The message you want to send to the topic.
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. See the Examples section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Publish call to return an error (no partial delivery).Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
" - }, - "MessageStructure":{ - "shape":"messageStructure", - "documentation":"Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., \"http\").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value: json
Message attributes for Publish action.
" - } - }, - "documentation":"Input for Publish action.
" - }, - "PublishResponse":{ - "type":"structure", - "members":{ - "MessageId":{ - "shape":"messageId", - "documentation":"Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
" - } - }, - "documentation":"Response for Publish action.
" - }, - "RemovePermissionInput":{ - "type":"structure", - "required":[ - "TopicArn", - "Label" - ], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic whose access control policy you wish to modify.
" - }, - "Label":{ - "shape":"label", - "documentation":"The unique label of the statement you want to remove.
" - } - }, - "documentation":"Input for RemovePermission action.
" - }, - "SetEndpointAttributesInput":{ - "type":"structure", - "required":[ - "EndpointArn", - "Attributes" - ], - "members":{ - "EndpointArn":{ - "shape":"String", - "documentation":"EndpointArn used for SetEndpointAttributes action.
" - }, - "Attributes":{ - "shape":"MapStringToString", - "documentation":"A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.Input for SetEndpointAttributes action.
" - }, - "SetPlatformApplicationAttributesInput":{ - "type":"structure", - "required":[ - "PlatformApplicationArn", - "Attributes" - ], - "members":{ - "PlatformApplicationArn":{ - "shape":"String", - "documentation":"PlatformApplicationArn for SetPlatformApplicationAttributes action.
" - }, - "Attributes":{ - "shape":"MapStringToString", - "documentation":"A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\".EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.Input for SetPlatformApplicationAttributes action.
" - }, - "SetSubscriptionAttributesInput":{ - "type":"structure", - "required":[ - "SubscriptionArn", - "AttributeName" - ], - "members":{ - "SubscriptionArn":{ - "shape":"subscriptionARN", - "documentation":"The ARN of the subscription to modify.
" - }, - "AttributeName":{ - "shape":"attributeName", - "documentation":"The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
The new value for the attribute in JSON format.
" - } - }, - "documentation":"Input for SetSubscriptionAttributes action.
" - }, - "SetTopicAttributesInput":{ - "type":"structure", - "required":[ - "TopicArn", - "AttributeName" - ], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic to modify.
" - }, - "AttributeName":{ - "shape":"attributeName", - "documentation":"The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
The new value for the attribute.
" - } - }, - "documentation":"Input for SetTopicAttributes action.
" - }, - "String":{"type":"string"}, - "SubscribeInput":{ - "type":"structure", - "required":[ - "TopicArn", - "Protocol" - ], - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the topic you want to subscribe to.
" - }, - "Protocol":{ - "shape":"protocol", - "documentation":"The protocol you want to use. Supported protocols include:
http -- delivery of JSON-encoded message via HTTP POSThttps -- delivery of JSON-encoded message via HTTPS POSTemail -- delivery of message via SMTPemail-json -- delivery of JSON-encoded message via SMTPsms -- delivery of message via SMSsqs -- delivery of JSON-encoded message to an Amazon SQS queueapplication -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.The endpoint that you want to receive notifications. Endpoints vary by protocol:
http protocol, the endpoint is an URL beginning with \"http://\"https protocol, the endpoint is a URL beginning with \"https://\"email protocol, the endpoint is an email addressemail-json protocol, the endpoint is an email addresssms protocol, the endpoint is a phone number of an SMS-enabled devicesqs protocol, the endpoint is the ARN of an Amazon SQS queueapplication protocol, the endpoint is the EndpointArn of a mobile app and device.The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
" - } - }, - "documentation":"Response for Subscribe action." - }, - "Subscription":{ - "type":"structure", - "members":{ - "SubscriptionArn":{ - "shape":"subscriptionARN", - "documentation":"The subscription's ARN.
" - }, - "Owner":{ - "shape":"account", - "documentation":"The subscription's owner.
" - }, - "Protocol":{ - "shape":"protocol", - "documentation":"The subscription's protocol.
" - }, - "Endpoint":{ - "shape":"endpoint", - "documentation":"The subscription's endpoint (format depends on the protocol).
" - }, - "TopicArn":{ - "shape":"topicARN", - "documentation":"The ARN of the subscription's topic.
" - } - }, - "documentation":"A wrapper type for the attributes of an Amazon SNS subscription.
" - }, - "SubscriptionAttributesMap":{ - "type":"map", - "key":{"shape":"attributeName"}, - "value":{"shape":"attributeValue"} - }, - "SubscriptionLimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"string"} - }, - "error":{ - "code":"SubscriptionLimitExceeded", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the customer already owns the maximum allowed number of subscriptions.
" - }, - "SubscriptionsList":{ - "type":"list", - "member":{"shape":"Subscription"} - }, - "Topic":{ - "type":"structure", - "members":{ - "TopicArn":{ - "shape":"topicARN", - "documentation":"The topic's ARN.
" - } - }, - "documentation":"A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
Indicates that the customer already owns the maximum allowed number of topics.
" - }, - "TopicsList":{ - "type":"list", - "member":{"shape":"Topic"} - }, - "UnsubscribeInput":{ - "type":"structure", - "required":["SubscriptionArn"], - "members":{ - "SubscriptionArn":{ - "shape":"subscriptionARN", - "documentation":"The ARN of the subscription to be deleted.
" - } - }, - "documentation":"Input for Unsubscribe action.
" - }, - "account":{"type":"string"}, - "action":{"type":"string"}, - "attributeName":{"type":"string"}, - "attributeValue":{"type":"string"}, - "authenticateOnUnsubscribe":{"type":"string"}, - "delegate":{"type":"string"}, - "endpoint":{"type":"string"}, - "label":{"type":"string"}, - "message":{"type":"string"}, - "messageId":{"type":"string"}, - "messageStructure":{"type":"string"}, - "nextToken":{"type":"string"}, - "protocol":{"type":"string"}, - "string":{"type":"string"}, - "subject":{"type":"string"}, - "subscriptionARN":{"type":"string"}, - "token":{"type":"string"}, - "topicARN":{"type":"string"}, - "topicName":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/sns/2010-03-31.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/sns/2010-03-31.paginators.json deleted file mode 100644 index 455e4708ec..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/sns/2010-03-31.paginators.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "pagination": { - "ListEndpointsByPlatformApplication": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "Endpoints" - }, - "ListPlatformApplications": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "PlatformApplications" - }, - "ListSubscriptions": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "Subscriptions" - }, - "ListSubscriptionsByTopic": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "Subscriptions" - }, - "ListTopics": { - "input_token": "NextToken", - "output_token": "NextToken", - "result_key": "Topics" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/sqs/2012-11-05.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/sqs/2012-11-05.normal.json deleted file mode 100644 index a63f1abb38..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/sqs/2012-11-05.normal.json +++ /dev/null @@ -1,1491 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-11-05", - "endpointPrefix":"sqs", - "serviceAbbreviation":"Amazon SQS", - "serviceFullName":"Amazon Simple Queue Service", - "signatureVersion":"v4", - "xmlNamespace":"http://queue.amazonaws.com/doc/2012-11-05/", - "protocol":"query" - }, - "documentation":"Welcome to the Amazon Simple Queue Service API Reference. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS).
Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available.
Helpful Links:
We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as:
For a list of available SDKs, go to Tools for Amazon Web Services.
", - "operations":{ - "AddPermission":{ - "name":"AddPermission", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddPermissionRequest"}, - "errors":[ - { - "shape":"OverLimit", - "error":{ - "code":"OverLimit", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. AddPermission returns this error if the maximum number of permissions for the queue has already been reached.
" - } - ], - "documentation":"Adds a permission to a queue for a specific principal. This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.
param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=this
&Attribute.2=that
The message referred to is not in flight.
" - }, - { - "shape":"ReceiptHandleIsInvalid", - "exception":true, - "documentation":"The receipt handle provided is not valid.
" - } - ], - "documentation":"Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.
There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.ChangeMessageVisibility action.For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
", - "resultWrapper":"ChangeMessageVisibilityBatchResult" - }, - "errors":[ - { - "shape":"TooManyEntriesInBatchRequest", - "error":{ - "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request contains more number of entries than permissible.
" - }, - { - "shape":"EmptyBatchRequest", - "error":{ - "code":"AWS.SimpleQueueService.EmptyBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request does not contain an entry.
" - }, - { - "shape":"BatchEntryIdsNotDistinct", - "error":{ - "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more batch entries have the same Id in the request.
The Id of a batch entry in a batch request does not abide by the specification.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.
param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=this
&Attribute.2=that
Returns the QueueUrl element of the created queue.
", - "resultWrapper":"CreateQueueResult" - }, - "errors":[ - { - "shape":"QueueDeletedRecently", - "error":{ - "code":"AWS.SimpleQueueService.QueueDeletedRecently", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You must wait 60 seconds after deleting a queue before you can create another with the same name.
" - }, - { - "shape":"QueueNameExists", - "error":{ - "code":"QueueAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.
" - } - ], - "documentation":"Creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.
Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.
If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, CreateQueue returns an error.
param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=this
&Attribute.2=that
The receipt handle is not valid for the current version.
" - }, - { - "shape":"ReceiptHandleIsInvalid", - "exception":true, - "documentation":"The receipt handle provided is not valid.
" - } - ], - "documentation":" Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the message ID you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it.
The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request DeleteMessage, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.
It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message cannot be deleted.
", - "resultWrapper":"DeleteMessageBatchResult" - }, - "errors":[ - { - "shape":"TooManyEntriesInBatchRequest", - "error":{ - "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request contains more number of entries than permissible.
" - }, - { - "shape":"EmptyBatchRequest", - "error":{ - "code":"AWS.SimpleQueueService.EmptyBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request does not contain an entry.
" - }, - { - "shape":"BatchEntryIdsNotDistinct", - "error":{ - "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more batch entries have the same Id in the request.
The Id of a batch entry in a batch request does not abide by the specification.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=this
&Attribute.2=that
Deletes the queue specified by the queue URL, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.
Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide.
" - }, - "GetQueueAttributes":{ - "name":"GetQueueAttributes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetQueueAttributesRequest"}, - "output":{ - "shape":"GetQueueAttributesResult", - "documentation":"A list of returned queue attributes.", - "resultWrapper":"GetQueueAttributesResult" - }, - "errors":[ - { - "shape":"InvalidAttributeName", - "exception":true, - "documentation":"The attribute referred to does not exist.
" - } - ], - "documentation":"Gets attributes for the specified queue. The following attributes are supported:
All - returns all values.ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).Policy - returns the queue's policy.MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.QueueArn - returns the queue's Amazon resource name (ARN).ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.DelaySeconds - returns the default delay on the queue in seconds.ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=this
&Attribute.2=that
For more information, see Responses in the Amazon SQS Developer Guide.
", - "resultWrapper":"GetQueueUrlResult" - }, - "errors":[ - { - "shape":"QueueDoesNotExist", - "error":{ - "code":"AWS.SimpleQueueService.NonExistentQueue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The queue referred to does not exist.
" - } - ], - "documentation":"Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or go to Shared Queues in the Amazon SQS Developer Guide.
The queue referred to does not exist.
" - } - ], - "documentation":"Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
" - }, - "ListQueues":{ - "name":"ListQueues", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListQueuesRequest"}, - "output":{ - "shape":"ListQueuesResult", - "documentation":"A list of your queues.", - "resultWrapper":"ListQueuesResult" - }, - "documentation":"Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name beginning with the specified value are returned.
The queue referred to does not exist.
" - }, - { - "shape":"PurgeQueueInProgress", - "error":{ - "code":"AWS.SimpleQueueService.PurgeQueueInProgress", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds, the time it can take to delete the messages in the queue.
Deletes the messages in a queue specified by the queue URL.
PurgeQueue API, the deleted messages in the queue cannot be retrieved.When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute.
The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. AddPermission returns this error if the maximum number of permissions for the queue has already been reached.
" - } - ], - "documentation":" Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response; in which case you should repeat the request.
For each message returned, the response includes the following:
Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
The MD5OfMessageBody and MessageId elements.
", - "resultWrapper":"SendMessageResult" - }, - "errors":[ - { - "shape":"InvalidMessageContents", - "exception":true, - "documentation":"The message contains characters outside the allowed set.
" - }, - { - "shape":"UnsupportedOperation", - "error":{ - "code":"AWS.SimpleQueueService.UnsupportedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error code 400. Unsupported operation.
" - } - ], - "documentation":"Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
", - "resultWrapper":"SendMessageBatchResult" - }, - "errors":[ - { - "shape":"TooManyEntriesInBatchRequest", - "error":{ - "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request contains more number of entries than permissible.
" - }, - { - "shape":"EmptyBatchRequest", - "error":{ - "code":"AWS.SimpleQueueService.EmptyBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request does not contain an entry.
" - }, - { - "shape":"BatchEntryIdsNotDistinct", - "error":{ - "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more batch entries have the same Id in the request.
The length of all the messages put together is more than the limit.
" - }, - { - "shape":"InvalidBatchEntryId", - "error":{ - "code":"AWS.SimpleQueueService.InvalidBatchEntryId", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Id of a batch entry in a batch request does not abide by the specification.
Error code 400. Unsupported operation.
" - } - ], - "documentation":"Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &Attribute.1=this
&Attribute.2=that
The attribute referred to does not exist.
" - } - ], - "documentation":"Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
The URL of the Amazon SQS queue to take action on.
" - }, - "Label":{ - "shape":"String", - "documentation":"The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.
" - }, - "Actions":{ - "shape":"ActionNameList", - "documentation":"The action the client wants to allow for the specified principal. The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
The name of a queue attribute.
", - "locationName":"Name" - }, - "value":{ - "shape":"String", - "documentation":"The value of a queue attribute.
", - "locationName":"Value" - }, - "flattened":true, - "locationName":"Attribute" - }, - "AttributeNameList":{ - "type":"list", - "member":{ - "shape":"QueueAttributeName", - "locationName":"AttributeName" - }, - "flattened":true - }, - "BatchEntryIdsNotDistinct":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Two or more batch entries have the same Id in the request.
The length of all the messages put together is more than the limit.
" - }, - "BatchResultErrorEntry":{ - "type":"structure", - "required":[ - "Id", - "SenderFault", - "Code" - ], - "members":{ - "Id":{ - "shape":"String", - "documentation":"The id of an entry in a batch request.
" - }, - "SenderFault":{ - "shape":"Boolean", - "documentation":"Whether the error happened due to the sender's fault.
" - }, - "Code":{ - "shape":"String", - "documentation":"An error code representing why the action failed on this entry.
" - }, - "Message":{ - "shape":"String", - "documentation":"A message explaining why the action failed on this entry.
" - } - }, - "documentation":"This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.
" - }, - "BatchResultErrorEntryList":{ - "type":"list", - "member":{ - "shape":"BatchResultErrorEntry", - "locationName":"BatchResultErrorEntry" - }, - "flattened":true - }, - "Binary":{"type":"blob"}, - "BinaryList":{ - "type":"list", - "member":{ - "shape":"Binary", - "locationName":"BinaryListValue" - } - }, - "Boolean":{"type":"boolean"}, - "ChangeMessageVisibilityBatchRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "Entries" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "Entries":{ - "shape":"ChangeMessageVisibilityBatchRequestEntryList", - "documentation":"A list of receipt handles of the messages for which the visibility timeout must be changed.
" - } - } - }, - "ChangeMessageVisibilityBatchRequestEntry":{ - "type":"structure", - "required":[ - "Id", - "ReceiptHandle" - ], - "members":{ - "Id":{ - "shape":"String", - "documentation":"An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.
A receipt handle.
" - }, - "VisibilityTimeout":{ - "shape":"Integer", - "documentation":"The new value (in seconds) for the message's visibility timeout.
" - } - }, - "documentation":"Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
All of the following parameters are list parameters that must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
A list of ChangeMessageVisibilityBatchResultEntry items.
" - }, - "Failed":{ - "shape":"BatchResultErrorEntryList", - "documentation":"A list of BatchResultErrorEntry items.
" - } - }, - "documentation":"For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
" - }, - "ChangeMessageVisibilityBatchResultEntry":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"String", - "documentation":"Represents a message whose visibility timeout has been changed successfully.
" - } - }, - "documentation":"Encloses the id of an entry in ChangeMessageVisibilityBatch.
" - }, - "ChangeMessageVisibilityBatchResultEntryList":{ - "type":"list", - "member":{ - "shape":"ChangeMessageVisibilityBatchResultEntry", - "locationName":"ChangeMessageVisibilityBatchResultEntry" - }, - "flattened":true - }, - "ChangeMessageVisibilityRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "ReceiptHandle", - "VisibilityTimeout" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "ReceiptHandle":{ - "shape":"String", - "documentation":"The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
" - }, - "VisibilityTimeout":{ - "shape":"Integer", - "documentation":"The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
" - } - } - }, - "CreateQueueRequest":{ - "type":"structure", - "required":["QueueName"], - "members":{ - "QueueName":{ - "shape":"String", - "documentation":"The name for the queue to be created.
" - }, - "Attributes":{ - "shape":"AttributeMap", - "documentation":"A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters the CreateQueue action uses:
DelaySeconds - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.The URL for the created Amazon SQS queue.
" - } - }, - "documentation":"Returns the QueueUrl element of the created queue.
" - }, - "DeleteMessageBatchRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "Entries" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "Entries":{ - "shape":"DeleteMessageBatchRequestEntryList", - "documentation":"A list of receipt handles for the messages to be deleted.
" - } - } - }, - "DeleteMessageBatchRequestEntry":{ - "type":"structure", - "required":[ - "Id", - "ReceiptHandle" - ], - "members":{ - "Id":{ - "shape":"String", - "documentation":"An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.
A receipt handle.
" - } - }, - "documentation":"Encloses a receipt handle and an identifier for it.
" - }, - "DeleteMessageBatchRequestEntryList":{ - "type":"list", - "member":{ - "shape":"DeleteMessageBatchRequestEntry", - "locationName":"DeleteMessageBatchRequestEntry" - }, - "flattened":true - }, - "DeleteMessageBatchResult":{ - "type":"structure", - "required":[ - "Successful", - "Failed" - ], - "members":{ - "Successful":{ - "shape":"DeleteMessageBatchResultEntryList", - "documentation":"A list of DeleteMessageBatchResultEntry items.
" - }, - "Failed":{ - "shape":"BatchResultErrorEntryList", - "documentation":"A list of BatchResultErrorEntry items.
" - } - }, - "documentation":"For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message cannot be deleted.
" - }, - "DeleteMessageBatchResultEntry":{ - "type":"structure", - "required":["Id"], - "members":{ - "Id":{ - "shape":"String", - "documentation":"Represents a successfully deleted message.
" - } - }, - "documentation":"Encloses the id an entry in DeleteMessageBatch.
" - }, - "DeleteMessageBatchResultEntryList":{ - "type":"list", - "member":{ - "shape":"DeleteMessageBatchResultEntry", - "locationName":"DeleteMessageBatchResultEntry" - }, - "flattened":true - }, - "DeleteMessageRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "ReceiptHandle" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "ReceiptHandle":{ - "shape":"String", - "documentation":"The receipt handle associated with the message to delete.
" - } - } - }, - "DeleteQueueRequest":{ - "type":"structure", - "required":["QueueUrl"], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - } - } - }, - "EmptyBatchRequest":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.EmptyBatchRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Batch request does not contain an entry.
" - }, - "GetQueueAttributesRequest":{ - "type":"structure", - "required":["QueueUrl"], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "AttributeNames":{ - "shape":"AttributeNameList", - "documentation":"A list of attributes to retrieve information for.
" - } - } - }, - "GetQueueAttributesResult":{ - "type":"structure", - "members":{ - "Attributes":{ - "shape":"AttributeMap", - "documentation":"A map of attributes to the respective values.
", - "locationName":"Attribute" - } - }, - "documentation":"A list of returned queue attributes." - }, - "GetQueueUrlRequest":{ - "type":"structure", - "required":["QueueName"], - "members":{ - "QueueName":{ - "shape":"String", - "documentation":"The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
" - }, - "QueueOwnerAWSAccountId":{ - "shape":"String", - "documentation":"The AWS account ID of the account that created the queue.
" - } - } - }, - "GetQueueUrlResult":{ - "type":"structure", - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL for the queue.
" - } - }, - "documentation":"For more information, see Responses in the Amazon SQS Developer Guide.
" - }, - "Integer":{"type":"integer"}, - "InvalidAttributeName":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The attribute referred to does not exist.
" - }, - "InvalidBatchEntryId":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.InvalidBatchEntryId", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The Id of a batch entry in a batch request does not abide by the specification.
The receipt handle is not valid for the current version.
" - }, - "InvalidMessageContents":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The message contains characters outside the allowed set.
" - }, - "ListDeadLetterSourceQueuesRequest":{ - "type":"structure", - "required":["QueueUrl"], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The queue URL of a dead letter queue." - } - } - }, - "ListDeadLetterSourceQueuesResult":{ - "type":"structure", - "required":["queueUrls"], - "members":{ - "queueUrls":{ - "shape":"QueueUrlList", - "documentation":"A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue." - } - }, - "documentation":"A list of your dead letter source queues." - }, - "ListQueuesRequest":{ - "type":"structure", - "members":{ - "QueueNamePrefix":{ - "shape":"String", - "documentation":"A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
" - } - } - }, - "ListQueuesResult":{ - "type":"structure", - "members":{ - "QueueUrls":{ - "shape":"QueueUrlList", - "documentation":"A list of queue URLs, up to 1000 entries.
" - } - }, - "documentation":"A list of your queues." - }, - "Message":{ - "type":"structure", - "members":{ - "MessageId":{ - "shape":"String", - "documentation":"A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.
" - }, - "ReceiptHandle":{ - "shape":"String", - "documentation":"An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
" - }, - "MD5OfBody":{ - "shape":"String", - "documentation":"An MD5 digest of the non-URL-encoded message body string.
" - }, - "Body":{ - "shape":"String", - "documentation":"The message's contents (not URL-encoded).
" - }, - "Attributes":{ - "shape":"AttributeMap", - "documentation":"SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.
An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
" - }, - "MessageAttributes":{ - "shape":"MessageAttributeMap", - "documentation":"Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
", - "locationName":"MessageAttribute" - } - }, - "documentation":"An Amazon SQS message.
" - }, - "MessageAttributeMap":{ - "type":"map", - "key":{ - "shape":"String", - "locationName":"Name" - }, - "value":{ - "shape":"MessageAttributeValue", - "locationName":"Value" - }, - "flattened":true - }, - "MessageAttributeName":{"type":"string"}, - "MessageAttributeNameList":{ - "type":"list", - "member":{ - "shape":"MessageAttributeName", - "locationName":"MessageAttributeName" - }, - "flattened":true - }, - "MessageAttributeValue":{ - "type":"structure", - "required":["DataType"], - "members":{ - "StringValue":{ - "shape":"String", - "documentation":"Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
" - }, - "BinaryValue":{ - "shape":"Binary", - "documentation":"Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
" - }, - "StringListValues":{ - "shape":"StringList", - "documentation":"Not implemented. Reserved for future use.
", - "flattened":true, - "locationName":"StringListValue" - }, - "BinaryListValues":{ - "shape":"BinaryList", - "documentation":"Not implemented. Reserved for future use.
", - "flattened":true, - "locationName":"BinaryListValue" - }, - "DataType":{ - "shape":"String", - "documentation":"Amazon SQS supports the following logical data types: String, Number, and Binary. In addition, you can append your own custom labels. For more information, see Message Attribute Data Types.
" - } - }, - "documentation":"The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).
" - }, - "MessageList":{ - "type":"list", - "member":{ - "shape":"Message", - "locationName":"Message" - }, - "flattened":true - }, - "MessageNotInflight":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.MessageNotInflight", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The message referred to is not in flight.
" - }, - "OverLimit":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"OverLimit", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. AddPermission returns this error if the maximum number of permissions for the queue has already been reached.
" - }, - "PurgeQueueInProgress":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.PurgeQueueInProgress", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds, the time it can take to delete the messages in the queue.
The queue URL of the queue to delete the messages from when using the PurgeQueue API.
You must wait 60 seconds after deleting a queue before you can create another with the same name.
" - }, - "QueueDoesNotExist":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.NonExistentQueue", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The queue referred to does not exist.
" - }, - "QueueNameExists":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"QueueAlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.
" - }, - "QueueUrlList":{ - "type":"list", - "member":{ - "shape":"String", - "locationName":"QueueUrl" - }, - "flattened":true - }, - "ReceiptHandleIsInvalid":{ - "type":"structure", - "members":{ - }, - "exception":true, - "documentation":"The receipt handle provided is not valid.
" - }, - "ReceiveMessageRequest":{ - "type":"structure", - "required":["QueueUrl"], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "AttributeNames":{ - "shape":"AttributeNameList", - "documentation":"A list of attributes that need to be returned along with each message.
The following lists the names and descriptions of the attributes that can be returned:
All - returns all values.ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with \"AWS.\" or \"Amazon.\" (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.
When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying \"All\" or \".*\" in your request. You can also use \"foo.*\" to return all message attributes starting with the \"foo\" prefix.
The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.
All of the messages are not necessarily returned.
" - }, - "VisibilityTimeout":{ - "shape":"Integer", - "documentation":"The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.
" - } - } - }, - "ReceiveMessageResult":{ - "type":"structure", - "members":{ - "Messages":{ - "shape":"MessageList", - "documentation":"A list of messages.
" - } - }, - "documentation":"A list of received messages." - }, - "RemovePermissionRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "Label" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "Label":{ - "shape":"String", - "documentation":"The identification of the permission to remove. This is the label added with the AddPermission action.
" - } - } - }, - "SendMessageBatchRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "Entries" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "Entries":{ - "shape":"SendMessageBatchRequestEntryList", - "documentation":"A list of SendMessageBatchRequestEntry items.
" - } - } - }, - "SendMessageBatchRequestEntry":{ - "type":"structure", - "required":[ - "Id", - "MessageBody" - ], - "members":{ - "Id":{ - "shape":"String", - "documentation":"An identifier for the message in this batch. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.
Body of the message.
" - }, - "DelaySeconds":{ - "shape":"Integer", - "documentation":"The number of seconds for which the message has to be delayed.
" - }, - "MessageAttributes":{ - "shape":"MessageAttributeMap", - "documentation":"Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
", - "locationName":"MessageAttribute" - } - }, - "documentation":"Contains the details of a single Amazon SQS message along with a Id.
A list of SendMessageBatchResultEntry items.
" - }, - "Failed":{ - "shape":"BatchResultErrorEntryList", - "documentation":"A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.
" - } - }, - "documentation":"For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
" - }, - "SendMessageBatchResultEntry":{ - "type":"structure", - "required":[ - "Id", - "MessageId", - "MD5OfMessageBody" - ], - "members":{ - "Id":{ - "shape":"String", - "documentation":"An identifier for the message in this batch.
" - }, - "MessageId":{ - "shape":"String", - "documentation":"An identifier for the message.
" - }, - "MD5OfMessageBody":{ - "shape":"String", - "documentation":"An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
" - }, - "MD5OfMessageAttributes":{ - "shape":"String", - "documentation":"An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
" - } - }, - "documentation":"Encloses a message ID for successfully enqueued message of a SendMessageBatch.
" - }, - "SendMessageBatchResultEntryList":{ - "type":"list", - "member":{ - "shape":"SendMessageBatchResultEntry", - "locationName":"SendMessageBatchResultEntry" - }, - "flattened":true - }, - "SendMessageRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "MessageBody" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "MessageBody":{ - "shape":"String", - "documentation":"The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
" - }, - "DelaySeconds":{ - "shape":"Integer", - "documentation":" The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
", - "locationName":"MessageAttribute" - } - } - }, - "SendMessageResult":{ - "type":"structure", - "members":{ - "MD5OfMessageBody":{ - "shape":"String", - "documentation":"An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
" - }, - "MD5OfMessageAttributes":{ - "shape":"String", - "documentation":"An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
" - }, - "MessageId":{ - "shape":"String", - "documentation":"An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
" - } - }, - "documentation":"The MD5OfMessageBody and MessageId elements.
" - }, - "SetQueueAttributesRequest":{ - "type":"structure", - "required":[ - "QueueUrl", - "Attributes" - ], - "members":{ - "QueueUrl":{ - "shape":"String", - "documentation":"The URL of the Amazon SQS queue to take action on.
" - }, - "Attributes":{ - "shape":"AttributeMap", - "documentation":"A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the SetQueueAttributes action uses:
DelaySeconds - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.RedrivePolicy - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.Batch request contains more number of entries than permissible.
" - }, - "UnsupportedOperation":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.UnsupportedOperation", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Error code 400. Unsupported operation.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/storagegateway/2013-06-30.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/storagegateway/2013-06-30.normal.json deleted file mode 100644 index 1f5590b1c3..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/storagegateway/2013-06-30.normal.json +++ /dev/null @@ -1,3256 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2013-06-30", - "endpointPrefix":"storagegateway", - "jsonVersion":"1.1", - "serviceFullName":"AWS Storage Gateway", - "signatureVersion":"v4", - "targetPrefix":"StorageGateway_20130630", - "protocol":"json" - }, - "documentation":"AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
A JSON object containing one or more of the following fields:
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.
An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
" - }, - "AddUploadBuffer":{ - "name":"AddUploadBuffer", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddUploadBufferInput"}, - "output":{"shape":"AddUploadBufferOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
" - }, - "AddWorkingStorage":{ - "name":"AddWorkingStorage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AddWorkingStorageInput", - "documentation":"A JSON object containing one or more of the following fields:
" - }, - "output":{ - "shape":"AddWorkingStorageOutput", - "documentation":"A JSON object containing the of the gateway for which working storage was configured.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
" - }, - "CancelArchival":{ - "name":"CancelArchival", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CancelArchivalInput", - "documentation":"CancelArchivalInput
" - }, - "output":{ - "shape":"CancelArchivalOutput", - "documentation":"CancelArchivalOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
" - }, - "CancelRetrieval":{ - "name":"CancelRetrieval", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CancelRetrievalInput", - "documentation":"CancelRetrievalInput
" - }, - "output":{ - "shape":"CancelRetrievalOutput", - "documentation":"CancelRetrievalOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.
" - }, - "CreateCachediSCSIVolume":{ - "name":"CreateCachediSCSIVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCachediSCSIVolumeInput"}, - "output":{"shape":"CreateCachediSCSIVolumeOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
" - }, - "CreateSnapshot":{ - "name":"CreateSnapshot", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateSnapshotInput", - "documentation":"A JSON object containing one or more of the following fields:
" - }, - "output":{ - "shape":"CreateSnapshotOutput", - "documentation":"A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use ListVolumeRecoveryPoints.
In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.
The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.
In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
" - }, - "CreateTapes":{ - "name":"CreateTapes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateTapesInput", - "documentation":"CreateTapesInput
" - }, - "output":{ - "shape":"CreateTapesOutput", - "documentation":"CreateTapeOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
A JSON object containing the of the gateway whose bandwidth rate information was deleted.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.
" - }, - "DeleteChapCredentials":{ - "name":"DeleteChapCredentials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteChapCredentialsInput", - "documentation":"A JSON object containing one or more of the following fields:
" - }, - "output":{ - "shape":"DeleteChapCredentialsOutput", - "documentation":"A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
" - }, - "DeleteGateway":{ - "name":"DeleteGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteGatewayInput", - "documentation":"A JSON object containing the of the gateway to delete.
" - }, - "output":{ - "shape":"DeleteGatewayOutput", - "documentation":"A JSON object containing the of the deleted gateway.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.
An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN).
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
DeleteTapeInput
" - }, - "output":{ - "shape":"DeleteTapeOutput", - "documentation":"DeleteTapeOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Deletes the specified virtual tape.
" - }, - "DeleteTapeArchive":{ - "name":"DeleteTapeArchive", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteTapeArchiveInput", - "documentation":"DeleteTapeArchiveInput
" - }, - "output":{ - "shape":"DeleteTapeArchiveOutput", - "documentation":"DeleteTapeArchiveOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Deletes the specified virtual tape from the virtual tape shelf (VTS).
" - }, - "DeleteVolume":{ - "name":"DeleteVolume", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteVolumeInput", - "documentation":"A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
" - }, - "output":{ - "shape":"DeleteVolumeOutput", - "documentation":"A JSON object containing the of the storage volume that was deleted
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation delete the specified gateway volume that you previously created using the CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
" - }, - "DescribeBandwidthRateLimit":{ - "name":"DescribeBandwidthRateLimit", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeBandwidthRateLimitInput", - "documentation":"A JSON object containing the of the gateway.
" - }, - "output":{ - "shape":"DescribeBandwidthRateLimitOutput", - "documentation":"A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
" - }, - "DescribeCache":{ - "name":"DescribeCache", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCacheInput"}, - "output":{"shape":"DescribeCacheOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
" - }, - "DescribeCachediSCSIVolumes":{ - "name":"DescribeCachediSCSIVolumes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCachediSCSIVolumesInput"}, - "output":{ - "shape":"DescribeCachediSCSIVolumesOutput", - "documentation":"A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
" - }, - "DescribeChapCredentials":{ - "name":"DescribeChapCredentials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeChapCredentialsInput", - "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
" - }, - "output":{ - "shape":"DescribeChapCredentialsOutput", - "documentation":"A JSON object containing a .
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
" - }, - "DescribeGatewayInformation":{ - "name":"DescribeGatewayInformation", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeGatewayInformationInput", - "documentation":"A JSON object containing the of the gateway.
" - }, - "output":{ - "shape":"DescribeGatewayInformationOutput", - "documentation":"A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
" - }, - "DescribeMaintenanceStartTime":{ - "name":"DescribeMaintenanceStartTime", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeMaintenanceStartTimeInput", - "documentation":"A JSON object containing the of the gateway.
" - }, - "output":{"shape":"DescribeMaintenanceStartTimeOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
" - }, - "DescribeSnapshotSchedule":{ - "name":"DescribeSnapshotSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeSnapshotScheduleInput", - "documentation":"A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
" - }, - "output":{"shape":"DescribeSnapshotScheduleOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
" - }, - "DescribeStorediSCSIVolumes":{ - "name":"DescribeStorediSCSIVolumes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeStorediSCSIVolumesInput", - "documentation":"A JSON Object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
" - }, - "output":{"shape":"DescribeStorediSCSIVolumesOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.
" - }, - "DescribeTapeArchives":{ - "name":"DescribeTapeArchives", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeTapeArchivesInput", - "documentation":"DescribeTapeArchivesInput
" - }, - "output":{ - "shape":"DescribeTapeArchivesOutput", - "documentation":"DescribeTapeArchivesOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
DescribeTapeRecoveryPointsInput
" - }, - "output":{ - "shape":"DescribeTapeRecoveryPointsOutput", - "documentation":"DescribeTapeRecoveryPointsOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
" - }, - "DescribeTapes":{ - "name":"DescribeTapes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeTapesInput", - "documentation":"DescribeTapesInput
" - }, - "output":{ - "shape":"DescribeTapesOutput", - "documentation":"DescribeTapesOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway.
An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
" - }, - "DescribeVTLDevices":{ - "name":"DescribeVTLDevices", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeVTLDevicesInput", - "documentation":"DescribeVTLDevicesInput
" - }, - "output":{ - "shape":"DescribeVTLDevicesOutput", - "documentation":"DescribeVTLDevicesOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway.
" - }, - "DescribeWorkingStorage":{ - "name":"DescribeWorkingStorage", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeWorkingStorageInput", - "documentation":"A JSON object containing the of the gateway.
" - }, - "output":{ - "shape":"DescribeWorkingStorageOutput", - "documentation":"A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
" - }, - "DisableGateway":{ - "name":"DisableGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DisableGatewayInput", - "documentation":"DisableGatewayInput
" - }, - "output":{ - "shape":"DisableGatewayOutput", - "documentation":"DisableGatewayOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a gateway-VTL that is not reachable or not functioning.
A JSON object containing zero or more of the following fields:
" - }, - "output":{"shape":"ListGatewaysOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.
" - }, - "ListLocalDisks":{ - "name":"ListLocalDisks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListLocalDisksInput", - "documentation":"A JSON object containing the of the gateway.
" - }, - "output":{"shape":"ListLocalDisksOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is availble to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
" - }, - "ListVolumes":{ - "name":"ListVolumes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"ListVolumesInput", - "documentation":"A JSON object that contains one or more of the following fields:
" - }, - "output":{"shape":"ListVolumesOutput"}, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.
An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation resets all cache disks and makes the disks available for reconfiguration as cache storage. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.
" - }, - "RetrieveTapeArchive":{ - "name":"RetrieveTapeArchive", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RetrieveTapeArchiveInput", - "documentation":"RetrieveTapeArchiveInput
" - }, - "output":{ - "shape":"RetrieveTapeArchiveOutput", - "documentation":"RetrieveTapeArchiveOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.
" - }, - "RetrieveTapeRecoveryPoint":{ - "name":"RetrieveTapeRecoveryPoint", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"RetrieveTapeRecoveryPointInput", - "documentation":"RetrieveTapeRecoveryPointInput
" - }, - "output":{ - "shape":"RetrieveTapeRecoveryPointOutput", - "documentation":"RetrieveTapeRecoveryPointOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"Retrieves the recovery point for the specified virtual tape.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
A JSON object containing the of the gateway to shut down.
" - }, - "output":{ - "shape":"ShutdownGatewayOutput", - "documentation":"A JSON object containing the of the gateway that was shut down.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
" - }, - "StartGateway":{ - "name":"StartGateway", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"StartGatewayInput", - "documentation":"A JSON object containing the of the gateway to start.
" - }, - "output":{ - "shape":"StartGatewayOutput", - "documentation":"A JSON object containing the of the gateway that was restarted.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
" - }, - "UpdateBandwidthRateLimit":{ - "name":"UpdateBandwidthRateLimit", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateBandwidthRateLimitInput", - "documentation":"A JSON object containing one or more of the following fields:
A JSON object containing the of the gateway whose throttle information was updated.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
" - }, - "UpdateChapCredentials":{ - "name":"UpdateChapCredentials", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateChapCredentialsInput", - "documentation":"A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
A JSON object containing the of the gateway that was updated.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
" - }, - "UpdateGatewaySoftwareNow":{ - "name":"UpdateGatewaySoftwareNow", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateGatewaySoftwareNowInput", - "documentation":"A JSON object containing the of the gateway to update.
" - }, - "output":{ - "shape":"UpdateGatewaySoftwareNowOutput", - "documentation":"A JSON object containing the of the gateway that was updated.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.A JSON object containing the following fields:
A JSON object containing the of the gateway whose maintenance start time is updated.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
" - }, - "UpdateSnapshotSchedule":{ - "name":"UpdateSnapshotSchedule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateSnapshotScheduleInput", - "documentation":"A JSON object containing one or more of the following fields:
A JSON object containing the of the updated storage volume.
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates a snapshot schedule configured for a gateway volume.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
" - }, - "UpdateVTLDeviceType":{ - "name":"UpdateVTLDeviceType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"UpdateVTLDeviceTypeInput", - "documentation":"UpdateVTLDeviceTypeInput
" - }, - "output":{ - "shape":"UpdateVTLDeviceTypeOutput", - "documentation":"UpdateVTLDeviceTypeOutput
" - }, - "errors":[ - { - "shape":"InvalidGatewayRequestException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - { - "shape":"InternalServerError", - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - } - ], - "documentation":"This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.
" - } - }, - "shapes":{ - "ActivateGatewayInput":{ - "type":"structure", - "required":[ - "ActivationKey", - "GatewayName", - "GatewayTimezone", - "GatewayRegion" - ], - "members":{ - "ActivationKey":{ - "shape":"ActivationKey", - "documentation":"Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.
One of the values that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
" - }, - "GatewayRegion":{ - "shape":"RegionId", - "documentation":"One of the values that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.
Valid Values: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"eu-central-1\", \"ap-northeast-1\", \"ap-southeast-1\", \"ap-southeast-2\", \"sa-east-1\"
" - }, - "GatewayType":{ - "shape":"GatewayType", - "documentation":"One of the values that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED.
The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.
Valid Values: \"IBM-ULT3580-TD5\"
" - }, - "MediumChangerType":{ - "shape":"MediumChangerType", - "documentation":"The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.
Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
" - }, - "ActivationKey":{ - "type":"string", - "min":1, - "max":50 - }, - "AddCacheInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "DiskIds" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskIds":{"shape":"DiskIds"} - } - }, - "AddCacheOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "AddUploadBufferInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "DiskIds" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskIds":{"shape":"DiskIds"} - } - }, - "AddUploadBufferOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "AddWorkingStorageInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "DiskIds" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskIds":{ - "shape":"DiskIds", - "documentation":"An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
" - }, - "AddWorkingStorageOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway for which working storage was configured.
" - }, - "BandwidthDownloadRateLimit":{ - "type":"long", - "min":102400 - }, - "BandwidthType":{ - "type":"string", - "min":3, - "max":25 - }, - "BandwidthUploadRateLimit":{ - "type":"long", - "min":51200 - }, - "CachediSCSIVolume":{ - "type":"structure", - "members":{ - "VolumeARN":{"shape":"VolumeARN"}, - "VolumeId":{"shape":"VolumeId"}, - "VolumeType":{"shape":"VolumeType"}, - "VolumeStatus":{"shape":"VolumeStatus"}, - "VolumeSizeInBytes":{"shape":"long"}, - "VolumeProgress":{"shape":"DoubleObject"}, - "SourceSnapshotId":{"shape":"SnapshotId"}, - "VolumeiSCSIAttributes":{"shape":"VolumeiSCSIAttributes"} - } - }, - "CachediSCSIVolumes":{ - "type":"list", - "member":{"shape":"CachediSCSIVolume"} - }, - "CancelArchivalInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "TapeARN" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
" - } - }, - "documentation":"CancelArchivalInput
" - }, - "CancelArchivalOutput":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
" - } - }, - "documentation":"CancelArchivalOutput
" - }, - "CancelRetrievalInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "TapeARN" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
" - } - }, - "documentation":"CancelRetrievalInput
" - }, - "CancelRetrievalOutput":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
" - } - }, - "documentation":"CancelRetrievalOutput
" - }, - "ChapCredentials":{ - "type":"list", - "member":{"shape":"ChapInfo"} - }, - "ChapInfo":{ - "type":"structure", - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" - }, - "SecretToAuthenticateInitiator":{ - "shape":"ChapSecret", - "documentation":"The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
" - }, - "InitiatorName":{ - "shape":"IqnName", - "documentation":"The iSCSI initiator that connects to the target.
" - }, - "SecretToAuthenticateTarget":{ - "shape":"ChapSecret", - "documentation":"The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
" - } - }, - "documentation":"Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
" - }, - "ChapSecret":{ - "type":"string", - "min":12, - "max":16 - }, - "ClientToken":{ - "type":"string", - "min":5, - "max":100 - }, - "CreateCachediSCSIVolumeInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "VolumeSizeInBytes", - "TargetName", - "NetworkInterfaceId", - "ClientToken" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "VolumeSizeInBytes":{"shape":"long"}, - "SnapshotId":{"shape":"SnapshotId"}, - "TargetName":{"shape":"TargetName"}, - "NetworkInterfaceId":{"shape":"NetworkInterfaceId"}, - "ClientToken":{"shape":"ClientToken"} - } - }, - "CreateCachediSCSIVolumeOutput":{ - "type":"structure", - "members":{ - "VolumeARN":{"shape":"VolumeARN"}, - "TargetARN":{"shape":"TargetARN"} - } - }, - "CreateSnapshotFromVolumeRecoveryPointInput":{ - "type":"structure", - "required":[ - "VolumeARN", - "SnapshotDescription" - ], - "members":{ - "VolumeARN":{"shape":"VolumeARN"}, - "SnapshotDescription":{"shape":"SnapshotDescription"} - } - }, - "CreateSnapshotFromVolumeRecoveryPointOutput":{ - "type":"structure", - "members":{ - "SnapshotId":{"shape":"SnapshotId"}, - "VolumeARN":{"shape":"VolumeARN"}, - "VolumeRecoveryPointTime":{"shape":"string"} - } - }, - "CreateSnapshotInput":{ - "type":"structure", - "required":[ - "VolumeARN", - "SnapshotDescription" - ], - "members":{ - "VolumeARN":{ - "shape":"VolumeARN", - "documentation":"The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
" - }, - "SnapshotDescription":{ - "shape":"SnapshotDescription", - "documentation":"Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
" - }, - "CreateSnapshotOutput":{ - "type":"structure", - "members":{ - "VolumeARN":{ - "shape":"VolumeARN", - "documentation":"The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
" - }, - "SnapshotId":{ - "shape":"SnapshotId", - "documentation":"The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).
A JSON object containing the following fields:
" - }, - "CreateStorediSCSIVolumeInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "DiskId", - "PreserveExistingData", - "TargetName", - "NetworkInterfaceId" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskId":{ - "shape":"DiskId", - "documentation":"The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
" - }, - "SnapshotId":{ - "shape":"SnapshotId", - "documentation":"The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
" - }, - "PreserveExistingData":{ - "shape":"boolean", - "documentation":"Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.
Valid Values: true, false
" - }, - "TargetName":{ - "shape":"TargetName", - "documentation":"The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.
The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
The Amazon Resource Name (ARN) of the configured volume.
" - }, - "VolumeSizeInBytes":{ - "shape":"long", - "documentation":"The size of the volume in bytes.
" - }, - "TargetARN":{ - "shape":"TargetARN", - "documentation":"he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "CreateTapesInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "TapeSizeInBytes", - "ClientToken", - "NumTapesToCreate", - "TapeBarcodePrefix" - ], - "members":{ - "GatewayARN":{ - "shape":"GatewayARN", - "documentation":"The unique Amazon Resource Name(ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.
" - }, - "TapeSizeInBytes":{ - "shape":"TapeSize", - "documentation":"The size, in bytes, of the virtual tapes you want to create.
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
ClientToken prevents creating the tape multiple times.The number of virtual tapes you want to create.
" - }, - "TapeBarcodePrefix":{ - "shape":"TapeBarcodePrefix", - "documentation":"A prefix you append to the barcode of the virtual tape you are creating. This makes a barcode unique.
CreateTapesInput
" - }, - "CreateTapesOutput":{ - "type":"structure", - "members":{ - "TapeARNs":{ - "shape":"TapeARNs", - "documentation":"A list of unique Amazon Resource Named (ARN) the represents the virtual tapes that were created.
" - } - }, - "documentation":"CreateTapeOutput
" - }, - "DayOfWeek":{ - "type":"integer", - "min":0, - "max":6 - }, - "DeleteBandwidthRateLimitInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "BandwidthType" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "BandwidthType":{"shape":"BandwidthType"} - } - }, - "DeleteBandwidthRateLimitOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway whose bandwidth rate information was deleted.
" - }, - "DeleteChapCredentialsInput":{ - "type":"structure", - "required":[ - "TargetARN", - "InitiatorName" - ], - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
" - }, - "InitiatorName":{ - "shape":"IqnName", - "documentation":"The iSCSI initiator that connects to the target.
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
" - }, - "DeleteChapCredentialsOutput":{ - "type":"structure", - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"The Amazon Resource Name (ARN) of the target.
" - }, - "InitiatorName":{ - "shape":"IqnName", - "documentation":"The iSCSI initiator that connects to the target.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "DeleteGatewayInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway to delete.
" - }, - "DeleteGatewayOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the deleted gateway.
" - }, - "DeleteSnapshotScheduleInput":{ - "type":"structure", - "required":["VolumeARN"], - "members":{ - "VolumeARN":{"shape":"VolumeARN"} - } - }, - "DeleteSnapshotScheduleOutput":{ - "type":"structure", - "members":{ - "VolumeARN":{"shape":"VolumeARN"} - } - }, - "DeleteTapeArchiveInput":{ - "type":"structure", - "required":["TapeARN"], - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
" - } - }, - "documentation":"DeleteTapeArchiveInput
" - }, - "DeleteTapeArchiveOutput":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
" - } - }, - "documentation":"DeleteTapeArchiveOutput
" - }, - "DeleteTapeInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "TapeARN" - ], - "members":{ - "GatewayARN":{ - "shape":"GatewayARN", - "documentation":"The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.
" - }, - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape to delete.
" - } - }, - "documentation":"DeleteTapeInput
" - }, - "DeleteTapeOutput":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the deleted virtual tape.
" - } - }, - "documentation":"DeleteTapeOutput
" - }, - "DeleteVolumeInput":{ - "type":"structure", - "required":["VolumeARN"], - "members":{ - "VolumeARN":{ - "shape":"VolumeARN", - "documentation":"The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
" - } - }, - "documentation":"A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
" - }, - "DeleteVolumeOutput":{ - "type":"structure", - "members":{ - "VolumeARN":{ - "shape":"VolumeARN", - "documentation":"The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
" - } - }, - "documentation":"A JSON object containing the of the storage volume that was deleted
" - }, - "DescribeBandwidthRateLimitInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway.
" - }, - "DescribeBandwidthRateLimitOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "AverageUploadRateLimitInBitsPerSec":{ - "shape":"BandwidthUploadRateLimit", - "documentation":"The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
" - }, - "AverageDownloadRateLimitInBitsPerSec":{ - "shape":"BandwidthDownloadRateLimit", - "documentation":"The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "DescribeCacheInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "DescribeCacheOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskIds":{"shape":"DiskIds"}, - "CacheAllocatedInBytes":{"shape":"long"}, - "CacheUsedPercentage":{"shape":"double"}, - "CacheDirtyPercentage":{"shape":"double"}, - "CacheHitPercentage":{"shape":"double"}, - "CacheMissPercentage":{"shape":"double"} - } - }, - "DescribeCachediSCSIVolumesInput":{ - "type":"structure", - "required":["VolumeARNs"], - "members":{ - "VolumeARNs":{"shape":"VolumeARNs"} - } - }, - "DescribeCachediSCSIVolumesOutput":{ - "type":"structure", - "members":{ - "CachediSCSIVolumes":{ - "shape":"CachediSCSIVolumes", - "documentation":"An array of objects where each object contains metadata about one cached volume.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "DescribeChapCredentialsInput":{ - "type":"structure", - "required":["TargetARN"], - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
" - } - }, - "documentation":"A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
" - }, - "DescribeChapCredentialsOutput":{ - "type":"structure", - "members":{ - "ChapCredentials":{ - "shape":"ChapCredentials", - "documentation":"An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
A JSON object containing a .
" - }, - "DescribeGatewayInformationInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway.
" - }, - "DescribeGatewayInformationOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "GatewayId":{ - "shape":"GatewayId", - "documentation":"The gateway ID.
" - }, - "GatewayTimezone":{ - "shape":"GatewayTimezone", - "documentation":"One of the values that indicates the time zone configured for the gateway.
" - }, - "GatewayState":{ - "shape":"GatewayState", - "documentation":"One of the values that indicates the operating state of the gateway.
" - }, - "GatewayNetworkInterfaces":{ - "shape":"GatewayNetworkInterfaces", - "documentation":"A NetworkInterface array that contains descriptions of the gateway network interfaces.
" - }, - "GatewayType":{ - "shape":"GatewayType", - "documentation":"TBD
" - }, - "NextUpdateAvailabilityDate":{ - "shape":"NextUpdateAvailabilityDate", - "documentation":"The date at which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "DescribeMaintenanceStartTimeInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway.
" - }, - "DescribeMaintenanceStartTimeOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "HourOfDay":{"shape":"HourOfDay"}, - "MinuteOfHour":{"shape":"MinuteOfHour"}, - "DayOfWeek":{"shape":"DayOfWeek"}, - "Timezone":{"shape":"GatewayTimezone"} - } - }, - "DescribeSnapshotScheduleInput":{ - "type":"structure", - "required":["VolumeARN"], - "members":{ - "VolumeARN":{ - "shape":"VolumeARN", - "documentation":"The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
" - } - }, - "documentation":"A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
" - }, - "DescribeSnapshotScheduleOutput":{ - "type":"structure", - "members":{ - "VolumeARN":{"shape":"VolumeARN"}, - "StartAt":{"shape":"HourOfDay"}, - "RecurrenceInHours":{"shape":"RecurrenceInHours"}, - "Description":{"shape":"Description"}, - "Timezone":{"shape":"GatewayTimezone"} - } - }, - "DescribeStorediSCSIVolumesInput":{ - "type":"structure", - "required":["VolumeARNs"], - "members":{ - "VolumeARNs":{ - "shape":"VolumeARNs", - "documentation":"An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
" - } - }, - "documentation":"A JSON Object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
" - }, - "DescribeStorediSCSIVolumesOutput":{ - "type":"structure", - "members":{ - "StorediSCSIVolumes":{"shape":"StorediSCSIVolumes"} - } - }, - "DescribeTapeArchivesInput":{ - "type":"structure", - "members":{ - "TapeARNs":{ - "shape":"TapeARNs", - "documentation":"Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string that indicates the position at which to begin describing virtual tapes.
" - }, - "Limit":{ - "shape":"PositiveIntObject", - "documentation":"Specifies that the number of virtual tapes descried be limited to the specified number.
" - } - }, - "documentation":"DescribeTapeArchivesInput
" - }, - "DescribeTapeArchivesOutput":{ - "type":"structure", - "members":{ - "TapeArchives":{ - "shape":"TapeArchives", - "documentation":"An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
" - } - }, - "documentation":"DescribeTapeArchivesOutput
" - }, - "DescribeTapeRecoveryPointsInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
" - }, - "Limit":{ - "shape":"PositiveIntObject", - "documentation":"Specifies that the number of virtual tape recovery points that are described be limited to the specified number.
" - } - }, - "documentation":"DescribeTapeRecoveryPointsInput
" - }, - "DescribeTapeRecoveryPointsOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "TapeRecoveryPointInfos":{ - "shape":"TapeRecoveryPointInfos", - "documentation":"An array of TapeRecoveryPointInfos that are available for the specified gateway.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
" - } - }, - "documentation":"DescribeTapeRecoveryPointsOutput
" - }, - "DescribeTapesInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "TapeARNs":{ - "shape":"TapeARNs", - "documentation":"Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
" - }, - "Limit":{ - "shape":"PositiveIntObject", - "documentation":"Specifies that the number of virtual tapes described be limited to the specified number.
DescribeTapesInput
" - }, - "DescribeTapesOutput":{ - "type":"structure", - "members":{ - "Tapes":{ - "shape":"Tapes", - "documentation":"An array of virtual tape descriptions.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
" - } - }, - "documentation":"DescribeTapesOutput
" - }, - "DescribeUploadBufferInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "DescribeUploadBufferOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskIds":{"shape":"DiskIds"}, - "UploadBufferUsedInBytes":{"shape":"long"}, - "UploadBufferAllocatedInBytes":{"shape":"long"} - } - }, - "DescribeVTLDevicesInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "VTLDeviceARNs":{ - "shape":"VTLDeviceARNs", - "documentation":"An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
An opaque string that indicates the position at which to begin describing the VTL devices.
" - }, - "Limit":{ - "shape":"PositiveIntObject", - "documentation":"Specifies that the number of VTL devices described be limited to the specified number.
" - } - }, - "documentation":"DescribeVTLDevicesInput
" - }, - "DescribeVTLDevicesOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "VTLDevices":{ - "shape":"VTLDevices", - "documentation":"An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
" - }, - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
" - } - }, - "documentation":"DescribeVTLDevicesOutput
" - }, - "DescribeWorkingStorageInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway.
" - }, - "DescribeWorkingStorageOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "DiskIds":{ - "shape":"DiskIds", - "documentation":"An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
" - }, - "WorkingStorageUsedInBytes":{ - "shape":"long", - "documentation":"The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
" - }, - "WorkingStorageAllocatedInBytes":{ - "shape":"long", - "documentation":"The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "Description":{ - "type":"string", - "min":1, - "max":255 - }, - "DeviceType":{ - "type":"string", - "min":2, - "max":50 - }, - "DeviceiSCSIAttributes":{ - "type":"structure", - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
" - }, - "NetworkInterfaceId":{ - "shape":"NetworkInterfaceId", - "documentation":"The network interface identifier of the VTL device.
" - }, - "NetworkInterfacePort":{ - "shape":"integer", - "documentation":"The port used to communicate with iSCSI VTL device targets.
" - }, - "ChapEnabled":{ - "shape":"boolean", - "documentation":"Indicates whether mutual CHAP is enabled for the iSCSI target.
" - } - }, - "documentation":"Lists iSCSI information about a VTL device.
" - }, - "DisableGatewayInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"DisableGatewayInput
" - }, - "DisableGatewayOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{ - "shape":"GatewayARN", - "documentation":"The unique Amazon Resource Name of the disabled gateway.
" - } - }, - "documentation":"DisableGatewayOutput
" - }, - "Disk":{ - "type":"structure", - "members":{ - "DiskId":{"shape":"DiskId"}, - "DiskPath":{"shape":"string"}, - "DiskNode":{"shape":"string"}, - "DiskStatus":{"shape":"string"}, - "DiskSizeInBytes":{"shape":"long"}, - "DiskAllocationType":{"shape":"DiskAllocationType"}, - "DiskAllocationResource":{"shape":"string"} - } - }, - "DiskAllocationType":{ - "type":"string", - "min":3, - "max":100 - }, - "DiskId":{ - "type":"string", - "min":1, - "max":300 - }, - "DiskIds":{ - "type":"list", - "member":{"shape":"DiskId"} - }, - "Disks":{ - "type":"list", - "member":{"shape":"Disk"} - }, - "DoubleObject":{"type":"double"}, - "ErrorCode":{ - "type":"string", - "enum":[ - "ActivationKeyExpired", - "ActivationKeyInvalid", - "ActivationKeyNotFound", - "GatewayInternalError", - "GatewayNotConnected", - "GatewayNotFound", - "GatewayProxyNetworkConnectionBusy", - "AuthenticationFailure", - "BandwidthThrottleScheduleNotFound", - "Blocked", - "CannotExportSnapshot", - "ChapCredentialNotFound", - "DiskAlreadyAllocated", - "DiskDoesNotExist", - "DiskSizeGreaterThanVolumeMaxSize", - "DiskSizeLessThanVolumeSize", - "DiskSizeNotGigAligned", - "DuplicateCertificateInfo", - "DuplicateSchedule", - "EndpointNotFound", - "IAMNotSupported", - "InitiatorInvalid", - "InitiatorNotFound", - "InternalError", - "InvalidGateway", - "InvalidEndpoint", - "InvalidParameters", - "InvalidSchedule", - "LocalStorageLimitExceeded", - "LunAlreadyAllocated ", - "LunInvalid", - "MaximumContentLengthExceeded", - "MaximumTapeCartridgeCountExceeded", - "MaximumVolumeCountExceeded", - "NetworkConfigurationChanged", - "NoDisksAvailable", - "NotImplemented", - "NotSupported", - "OperationAborted", - "OutdatedGateway", - "ParametersNotImplemented", - "RegionInvalid", - "RequestTimeout", - "ServiceUnavailable", - "SnapshotDeleted", - "SnapshotIdInvalid", - "SnapshotInProgress", - "SnapshotNotFound", - "SnapshotScheduleNotFound", - "StagingAreaFull", - "StorageFailure", - "TapeCartridgeNotFound", - "TargetAlreadyExists", - "TargetInvalid", - "TargetNotFound", - "UnauthorizedOperation", - "VolumeAlreadyExists", - "VolumeIdInvalid", - "VolumeInUse", - "VolumeNotFound", - "VolumeNotReady" - ] - }, - "GatewayARN":{ - "type":"string", - "min":50, - "max":500, - "documentation":"The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
" - }, - "GatewayId":{ - "type":"string", - "min":12, - "max":30 - }, - "GatewayInfo":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "GatewayType":{"shape":"GatewayType"}, - "GatewayOperationalState":{"shape":"GatewayOperationalState"} - } - }, - "GatewayName":{ - "type":"string", - "min":2, - "max":255, - "pattern":"^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", - "documentation":"A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.
" - }, - "GatewayNetworkInterfaces":{ - "type":"list", - "member":{"shape":"NetworkInterface"} - }, - "GatewayOperationalState":{ - "type":"string", - "min":2, - "max":25 - }, - "GatewayState":{ - "type":"string", - "min":2, - "max":25 - }, - "GatewayTimezone":{ - "type":"string", - "min":3, - "max":10 - }, - "GatewayType":{ - "type":"string", - "min":2, - "max":20 - }, - "Gateways":{ - "type":"list", - "member":{"shape":"GatewayInfo"} - }, - "HourOfDay":{ - "type":"integer", - "min":0, - "max":23 - }, - "InternalServerError":{ - "type":"structure", - "members":{ - "message":{ - "shape":"string", - "documentation":"A human-readable message describing the error that occurred.
" - }, - "error":{ - "shape":"StorageGatewayError", - "documentation":"A StorageGatewayError that provides more detail about the cause of the error.
" - } - }, - "error":{"httpStatusCode":500}, - "exception":true, - "documentation":"An internal server error has occurred during the request. See the error and message fields for more information.
" - }, - "InvalidGatewayRequestException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"string", - "documentation":"A human-readable message describing the error that occurred.
" - }, - "error":{ - "shape":"StorageGatewayError", - "documentation":"A StorageGatewayError that provides more detail about the cause of the error.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information.
" - }, - "IqnName":{ - "type":"string", - "min":1, - "max":255, - "pattern":"[0-9a-z:.-]+" - }, - "ListGatewaysInput":{ - "type":"structure", - "members":{ - "Marker":{ - "shape":"Marker", - "documentation":"An opaque string that indicates the position at which to begin the returned list of gateways.
" - }, - "Limit":{ - "shape":"PositiveIntObject", - "documentation":"Specifies that the list of gateways returned be limited to the specified number of items.
" - } - }, - "documentation":"A JSON object containing zero or more of the following fields:
" - }, - "ListGatewaysOutput":{ - "type":"structure", - "members":{ - "Gateways":{"shape":"Gateways"}, - "Marker":{"shape":"Marker"} - } - }, - "ListLocalDisksInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway.
" - }, - "ListLocalDisksOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "Disks":{"shape":"Disks"} - } - }, - "ListVolumeRecoveryPointsInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "ListVolumeRecoveryPointsOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "VolumeRecoveryPointInfos":{"shape":"VolumeRecoveryPointInfos"} - } - }, - "ListVolumesInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "Marker":{ - "shape":"Marker", - "documentation":"A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
" - }, - "Limit":{ - "shape":"PositiveIntObject", - "documentation":"Specifies that the list of volumes returned be limited to the specified number of items.
" - } - }, - "documentation":"A JSON object that contains one or more of the following fields:
" - }, - "ListVolumesOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "Marker":{"shape":"Marker"}, - "VolumeInfos":{"shape":"VolumeInfos"} - } - }, - "Marker":{ - "type":"string", - "min":1, - "max":1000 - }, - "MediumChangerType":{ - "type":"string", - "min":2, - "max":50 - }, - "MinuteOfHour":{ - "type":"integer", - "min":0, - "max":59 - }, - "NetworkInterface":{ - "type":"structure", - "members":{ - "Ipv4Address":{ - "shape":"string", - "documentation":"The Internet Protocol version 4 (IPv4) address of the interface.
" - }, - "MacAddress":{ - "shape":"string", - "documentation":"The Media Access Control (MAC) address of the interface.
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
" - } - }, - "documentation":"Describes a gateway's network interface.
" - }, - "NetworkInterfaceId":{ - "type":"string", - "pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z" - }, - "NextUpdateAvailabilityDate":{ - "type":"string", - "min":1, - "max":25 - }, - "NumTapesToCreate":{ - "type":"integer", - "min":1, - "max":10 - }, - "PositiveIntObject":{ - "type":"integer", - "min":1 - }, - "RecurrenceInHours":{ - "type":"integer", - "min":1, - "max":24 - }, - "RegionId":{ - "type":"string", - "min":1, - "max":25 - }, - "ResetCacheInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "ResetCacheOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - } - }, - "RetrieveTapeArchiveInput":{ - "type":"structure", - "required":[ - "TapeARN", - "GatewayARN" - ], - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
" - }, - "GatewayARN":{ - "shape":"GatewayARN", - "documentation":"The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.
" - } - }, - "documentation":"RetrieveTapeArchiveInput
" - }, - "RetrieveTapeArchiveOutput":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the retrieved virtual tape.
" - } - }, - "documentation":"RetrieveTapeArchiveOutput
" - }, - "RetrieveTapeRecoveryPointInput":{ - "type":"structure", - "required":[ - "TapeARN", - "GatewayARN" - ], - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
" - }, - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"RetrieveTapeRecoveryPointInput
" - }, - "RetrieveTapeRecoveryPointOutput":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
" - } - }, - "documentation":"RetrieveTapeRecoveryPointOutput
" - }, - "ShutdownGatewayInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway to shut down.
" - }, - "ShutdownGatewayOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway that was shut down.
" - }, - "SnapshotDescription":{ - "type":"string", - "min":1, - "max":255 - }, - "SnapshotId":{ - "type":"string", - "pattern":"\\Asnap-[0-9a-fA-F]{8}\\z" - }, - "StartGatewayInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway to start.
" - }, - "StartGatewayOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway that was restarted.
" - }, - "StorageGatewayError":{ - "type":"structure", - "members":{ - "errorCode":{ - "shape":"ErrorCode", - "documentation":"Additional information about the error.
" - }, - "errorDetails":{ - "shape":"errorDetails", - "documentation":"Human-readable text that provides detail about the error that occurred.
" - } - }, - "documentation":"Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.
The Amazon Resource Name (ARN) of the virtual tape.
" - }, - "TapeBarcode":{ - "shape":"TapeBarcode", - "documentation":"The barcode that identifies a specific virtual tape.
" - }, - "TapeSizeInBytes":{ - "shape":"TapeSize", - "documentation":"The size, in bytes, of the virtual tape.
" - }, - "TapeStatus":{ - "shape":"TapeStatus", - "documentation":"The current state of the virtual tape.
" - }, - "VTLDevice":{ - "shape":"VTLDeviceARN", - "documentation":"The virtual tape library (VTL) device that the virtual tape is associated with.
" - }, - "Progress":{ - "shape":"DoubleObject", - "documentation":"For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
" - } - }, - "documentation":"Describes a virtual tape object.
" - }, - "TapeARN":{ - "type":"string", - "min":50, - "max":500 - }, - "TapeARNs":{ - "type":"list", - "member":{"shape":"TapeARN"} - }, - "TapeArchive":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of an archived virtual tape.
" - }, - "TapeBarcode":{ - "shape":"TapeBarcode", - "documentation":"The barcode that identifies the archived virtual tape.
" - }, - "TapeSizeInBytes":{ - "shape":"TapeSize", - "documentation":"The size, in bytes, of the archived virtual tape.
" - }, - "CompletionTime":{ - "shape":"Time", - "documentation":"The time that the archiving of the virtual tape was completed.
The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
" - }, - "RetrievedTo":{ - "shape":"GatewayARN", - "documentation":"The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
" - }, - "TapeStatus":{ - "shape":"TapeArchiveStatus", - "documentation":"The current state of the archived virtual tape.
" - } - }, - "documentation":"Represents a virtual tape that is archived in the virtual tape shelf (VTS).
" - }, - "TapeArchiveStatus":{"type":"string"}, - "TapeArchives":{ - "type":"list", - "member":{"shape":"TapeArchive"} - }, - "TapeBarcode":{ - "type":"string", - "min":8, - "max":16, - "pattern":"^[A-Z0-9]*$" - }, - "TapeBarcodePrefix":{ - "type":"string", - "min":1, - "max":4, - "pattern":"^[A-Z]*$" - }, - "TapeDriveType":{ - "type":"string", - "min":2, - "max":50 - }, - "TapeRecoveryPointInfo":{ - "type":"structure", - "members":{ - "TapeARN":{ - "shape":"TapeARN", - "documentation":"The Amazon Resource Name (ARN) of the virtual tape.
" - }, - "TapeRecoveryPointTime":{ - "shape":"Time", - "documentation":"The time when the point-in-time view of the virtual tape was replicated for later recovery.
The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
" - }, - "TapeSizeInBytes":{ - "shape":"TapeSize", - "documentation":"The size, in bytes, of the virtual tapes to recover.
" - }, - "TapeStatus":{"shape":"TapeRecoveryPointStatus"} - }, - "documentation":"Describes a recovery point.
" - }, - "TapeRecoveryPointInfos":{ - "type":"list", - "member":{"shape":"TapeRecoveryPointInfo"} - }, - "TapeRecoveryPointStatus":{"type":"string"}, - "TapeSize":{"type":"long"}, - "TapeStatus":{"type":"string"}, - "Tapes":{ - "type":"list", - "member":{"shape":"Tape"} - }, - "TargetARN":{ - "type":"string", - "min":50, - "max":800 - }, - "TargetName":{ - "type":"string", - "min":1, - "max":200, - "pattern":"^[-\\.;a-z0-9]+$" - }, - "Time":{"type":"timestamp"}, - "UpdateBandwidthRateLimitInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "AverageUploadRateLimitInBitsPerSec":{ - "shape":"BandwidthUploadRateLimit", - "documentation":"The average upload bandwidth rate limit in bits per second.
" - }, - "AverageDownloadRateLimitInBitsPerSec":{ - "shape":"BandwidthDownloadRateLimit", - "documentation":"The average download bandwidth rate limit in bits per second.
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
A JSON object containing the of the gateway whose throttle information was updated.
" - }, - "UpdateChapCredentialsInput":{ - "type":"structure", - "required":[ - "TargetARN", - "SecretToAuthenticateInitiator", - "InitiatorName" - ], - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
" - }, - "SecretToAuthenticateInitiator":{ - "shape":"ChapSecret", - "documentation":"The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
" - }, - "InitiatorName":{ - "shape":"IqnName", - "documentation":"The iSCSI initiator that connects to the target.
" - }, - "SecretToAuthenticateTarget":{ - "shape":"ChapSecret", - "documentation":"The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
" - }, - "InitiatorName":{ - "shape":"IqnName", - "documentation":"The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
" - } - }, - "documentation":"A JSON object containing the following fields:
" - }, - "UpdateGatewayInformationInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "GatewayName":{"shape":"GatewayName"}, - "GatewayTimezone":{"shape":"GatewayTimezone"} - } - }, - "UpdateGatewayInformationOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway that was updated.
" - }, - "UpdateGatewaySoftwareNowInput":{ - "type":"structure", - "required":["GatewayARN"], - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway to update.
" - }, - "UpdateGatewaySoftwareNowOutput":{ - "type":"structure", - "members":{ - "GatewayARN":{"shape":"GatewayARN"} - }, - "documentation":"A JSON object containing the of the gateway that was updated.
" - }, - "UpdateMaintenanceStartTimeInput":{ - "type":"structure", - "required":[ - "GatewayARN", - "HourOfDay", - "MinuteOfHour", - "DayOfWeek" - ], - "members":{ - "GatewayARN":{"shape":"GatewayARN"}, - "HourOfDay":{ - "shape":"HourOfDay", - "documentation":"The hour component of the maintenance start time represented as
The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
" - }, - "DayOfWeek":{ - "shape":"DayOfWeek", - "documentation":"The maintenance start time day of the week.
" - } - }, - "documentation":"A JSON object containing the following fields:
A JSON object containing the of the gateway whose maintenance start time is updated.
" - }, - "UpdateSnapshotScheduleInput":{ - "type":"structure", - "required":[ - "VolumeARN", - "StartAt", - "RecurrenceInHours" - ], - "members":{ - "VolumeARN":{ - "shape":"VolumeARN", - "documentation":"The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
" - }, - "StartAt":{ - "shape":"HourOfDay", - "documentation":"The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
" - }, - "RecurrenceInHours":{ - "shape":"RecurrenceInHours", - "documentation":"Frequency of snapshots. Specify the number of hours between snapshots.
" - }, - "Description":{ - "shape":"Description", - "documentation":"Optional description of the snapshot that overwrites the existing description.
" - } - }, - "documentation":"A JSON object containing one or more of the following fields:
A JSON object containing the of the updated storage volume.
" - }, - "UpdateVTLDeviceTypeInput":{ - "type":"structure", - "required":[ - "VTLDeviceARN", - "DeviceType" - ], - "members":{ - "VTLDeviceARN":{ - "shape":"VTLDeviceARN", - "documentation":"The Amazon Resource Name (ARN) of the medium changer you want to select.
" - }, - "DeviceType":{ - "shape":"DeviceType", - "documentation":"The type of medium changer you want to select.
Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"
" - } - }, - "documentation":"UpdateVTLDeviceTypeInput
" - }, - "UpdateVTLDeviceTypeOutput":{ - "type":"structure", - "members":{ - "VTLDeviceARN":{ - "shape":"VTLDeviceARN", - "documentation":"The Amazon Resource Name (ARN) of the medium changer you have selected.
" - } - }, - "documentation":"UpdateVTLDeviceTypeOutput
" - }, - "VTLDevice":{ - "type":"structure", - "members":{ - "VTLDeviceARN":{ - "shape":"VTLDeviceARN", - "documentation":"Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
" - }, - "VTLDeviceType":{"shape":"VTLDeviceType"}, - "VTLDeviceVendor":{"shape":"VTLDeviceVendor"}, - "VTLDeviceProductIdentifier":{"shape":"VTLDeviceProductIdentifier"}, - "DeviceiSCSIAttributes":{ - "shape":"DeviceiSCSIAttributes", - "documentation":"A list of iSCSI information about a VTL device.
" - } - }, - "documentation":"Represents a device object associated with a gateway-VTL.
" - }, - "VTLDeviceARN":{ - "type":"string", - "min":50, - "max":500 - }, - "VTLDeviceARNs":{ - "type":"list", - "member":{"shape":"VTLDeviceARN"} - }, - "VTLDeviceProductIdentifier":{"type":"string"}, - "VTLDeviceType":{"type":"string"}, - "VTLDeviceVendor":{"type":"string"}, - "VTLDevices":{ - "type":"list", - "member":{"shape":"VTLDevice"} - }, - "VolumeARN":{ - "type":"string", - "min":50, - "max":500 - }, - "VolumeARNs":{ - "type":"list", - "member":{"shape":"VolumeARN"} - }, - "VolumeId":{ - "type":"string", - "min":12, - "max":30 - }, - "VolumeInfo":{ - "type":"structure", - "members":{ - "VolumeARN":{"shape":"VolumeARN"}, - "VolumeType":{"shape":"VolumeType"} - } - }, - "VolumeInfos":{ - "type":"list", - "member":{"shape":"VolumeInfo"} - }, - "VolumeRecoveryPointInfo":{ - "type":"structure", - "members":{ - "VolumeARN":{"shape":"VolumeARN"}, - "VolumeSizeInBytes":{"shape":"long"}, - "VolumeUsageInBytes":{"shape":"long"}, - "VolumeRecoveryPointTime":{"shape":"string"} - } - }, - "VolumeRecoveryPointInfos":{ - "type":"list", - "member":{"shape":"VolumeRecoveryPointInfo"} - }, - "VolumeStatus":{ - "type":"string", - "min":3, - "max":50 - }, - "VolumeType":{ - "type":"string", - "min":3, - "max":100 - }, - "VolumeiSCSIAttributes":{ - "type":"structure", - "members":{ - "TargetARN":{ - "shape":"TargetARN", - "documentation":"The Amazon Resource Name (ARN) of the volume target.
" - }, - "NetworkInterfaceId":{ - "shape":"NetworkInterfaceId", - "documentation":"The network interface identifier.
" - }, - "NetworkInterfacePort":{ - "shape":"integer", - "documentation":"The port used to communicate with iSCSI targets.
" - }, - "LunNumber":{ - "shape":"PositiveIntObject", - "documentation":"The logical disk number.
" - }, - "ChapEnabled":{ - "shape":"boolean", - "documentation":"Indicates whether mutual CHAP is enabled for the iSCSI target.
" - } - }, - "documentation":"Lists iSCSI information about a volume.
" - }, - "boolean":{"type":"boolean"}, - "double":{"type":"double"}, - "errorDetails":{ - "type":"map", - "key":{"shape":"string"}, - "value":{"shape":"string"} - }, - "integer":{"type":"integer"}, - "long":{"type":"long"}, - "string":{"type":"string"} - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/storagegateway/2013-06-30.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/storagegateway/2013-06-30.paginators.json deleted file mode 100644 index b5e10c0589..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/storagegateway/2013-06-30.paginators.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "pagination": { - "DescribeTapeArchives": { - "input_token": "Marker", - "limit_key": "Limit", - "output_token": "Marker", - "result_key": "TapeArchives" - }, - "DescribeTapeRecoveryPoints": { - "input_token": "Marker", - "limit_key": "Limit", - "output_token": "Marker", - "result_key": "TapeRecoveryPointInfos" - }, - "DescribeTapes": { - "input_token": "Marker", - "limit_key": "Limit", - "output_token": "Marker", - "result_key": "Tapes" - }, - "DescribeVTLDevices": { - "input_token": "Marker", - "limit_key": "Limit", - "output_token": "Marker", - "result_key": "VTLDevices" - }, - "ListGateways": { - "input_token": "Marker", - "limit_key": "Limit", - "output_token": "Marker", - "result_key": "Gateways" - }, - "ListVolumes": { - "input_token": "Marker", - "limit_key": "Limit", - "output_token": "Marker", - "result_key": "VolumeInfos" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/sts/2011-06-15.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/sts/2011-06-15.normal.json deleted file mode 100644 index 5fad703318..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/sts/2011-06-15.normal.json +++ /dev/null @@ -1,801 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2011-06-15", - "endpointPrefix":"sts", - "globalEndpoint":"sts.amazonaws.com", - "serviceAbbreviation":"AWS STS", - "serviceFullName":"AWS Security Token Service", - "signatureVersion":"v4", - "xmlNamespace":"https://sts.amazonaws.com/doc/2011-06-15/", - "protocol":"query" - }, - "documentation":"The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Using Temporary Security Credentials.
For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to Using Temporary Security Credentials to Access AWS in Using Temporary Security Credentials.
If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.
Endpoints
For information about STS endpoints, see Regions and Endpoints in the AWS General Reference.
Recording API requests
STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
", - "operations":{ - "AssumeRole":{ - "name":"AssumeRole", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AssumeRoleRequest"}, - "output":{ - "shape":"AssumeRoleResponse", - "documentation":"Contains the result of a successful call to the AssumeRole action, including temporary AWS credentials that can be used to make AWS requests.
", - "resultWrapper":"AssumeRoleResult" - }, - "errors":[ - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"PackedPolicyTooLargeException", - "error":{ - "code":"PackedPolicyTooLarge", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.
" - } - ], - "documentation":"Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use AssumeRole for cross-account access or federation.
Important: You cannot call AssumeRole by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call AssumeRole.
For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see Roles in Using IAM.
For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call AssumeRole (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see Scenarios for Granting Temporary Access in Using Temporary Security Credentials.
The temporary security credentials are valid for the duration that you specified when calling AssumeRole, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole in Using Temporary Security Credentials.
To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. You must also have a policy that allows you to call sts:AssumeRole.
Using MFA with AssumeRole
You can optionally include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.
\"Condition\": {\"Null\": {\"aws:MultiFactorAuthAge\": false}}
For more information, see Configuring MFA-Protected API Access in the Using IAM guide.
To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA devices produces.
Contains the result of a successful call to the AssumeRoleWithSAML action, including temporary AWS credentials that can be used to make AWS requests.
", - "resultWrapper":"AssumeRoleWithSAMLResult" - }, - "errors":[ - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"PackedPolicyTooLargeException", - "error":{ - "code":"PackedPolicyTooLarge", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.
" - }, - { - "shape":"IDPRejectedClaimException", - "error":{ - "code":"IDPRejectedClaim", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.
If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.
The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.
" - }, - { - "shape":"ExpiredTokenException", - "error":{ - "code":"ExpiredTokenException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.
" - } - ], - "documentation":"Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration.
The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. The credentials are valid for the duration that you specified when calling AssumeRoleWithSAML, which can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication response's NotOnOrAfter value, whichever is shorter.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithSAML in Using Temporary Security Credentials.
Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy.
Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.
For more information, see the following resources:
Contains the result of a successful call to the AssumeRoleWithWebIdentity action, including temporary AWS credentials that can be used to make AWS requests.
", - "resultWrapper":"AssumeRoleWithWebIdentityResult" - }, - "errors":[ - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"PackedPolicyTooLargeException", - "error":{ - "code":"PackedPolicyTooLarge", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.
" - }, - { - "shape":"IDPRejectedClaimException", - "error":{ - "code":"IDPRejectedClaim", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.
If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.
The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.
" - }, - { - "shape":"InvalidIdentityTokenException", - "error":{ - "code":"InvalidIdentityToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.
" - }, - { - "shape":"ExpiredTokenException", - "error":{ - "code":"ExpiredTokenException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.
" - } - ], - "documentation":"Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Amazon Cognito, Facebook, or Google.
Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider.
The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling AssumeRoleWithWebIdentity, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in Using Temporary Security Credentials.
Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.
For more information about how to use web identity federation and the AssumeRoleWithWebIdentity, see the following resources:
A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request.
", - "resultWrapper":"DecodeAuthorizationMessageResult" - }, - "errors":[ - { - "shape":"InvalidAuthorizationMessageException", - "error":{ - "code":"InvalidAuthorizationMessageException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.
Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.
For example, if a user is not authorized to perform an action that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure.
The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
Contains the result of a successful call to the GetFederationToken action, including temporary AWS credentials that can be used to make AWS requests.
", - "resultWrapper":"GetFederationTokenResult" - }, - "errors":[ - { - "shape":"MalformedPolicyDocumentException", - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - { - "shape":"PackedPolicyTooLargeException", - "error":{ - "code":"PackedPolicyTooLarge", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.
" - } - ], - "documentation":"Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the GetFederationToken action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application.
Note: Do not use this call in mobile applications or client-based web applications that directly get temporary security credentials. For those types of applications, use AssumeRoleWithWebIdentity.
The GetFederationToken action must be called by using the long-term AWS security credentials of an IAM user. You can also call GetFederationToken using the security credentials of an AWS account (root), but this is not recommended. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources they need access to. For more information, see IAM Best Practices in Using IAM.
The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour)
Permissions
The permissions for the temporary security credentials returned by GetFederationToken are determined by a combination of the following:
GetFederationToken.The passed policy is attached to the temporary security credentials that result from the GetFederationToken API call--that is, to the federated user. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call GetFederationToken. AWS allows the federated user's request only when both the federated user and the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy.
A typical use case is that the permissions of the IAM user whose credentials are used to call GetFederationToken are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials. For information about using GetFederationToken to create temporary security credentials, see Creating Temporary Credentials to Enable Access for Federated Users in Using Temporary Security Credentials.
Contains the result of a successful call to the GetSessionToken action, including temporary AWS credentials that can be used to make AWS requests.
", - "resultWrapper":"GetSessionTokenResult" - }, - "documentation":"Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication.
The GetSessionToken action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour).
The permissions associated with the temporary security credentials returned by GetSessionToken are based on the permissions associated with account or IAM user whose credentials are used to call the action. If GetSessionToken is called using root account credentials, the temporary credentials have root account permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken to create temporary credentials, go to Creating Temporary Credentials to Enable Access for IAM Users in Using Temporary Security Credentials.
The Amazon Resource Name (ARN) of the role that the caller is assuming.
" - }, - "RoleSessionName":{ - "shape":"userNameType", - "documentation":"An identifier for the assumed role session. The session name is included as part of the AssumedRoleUser.
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole in Using Temporary Security Credentials.
" - }, - "DurationSeconds":{ - "shape":"roleDurationSecondsType", - "documentation":"The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
" - }, - "ExternalId":{ - "shape":"externalIdType", - "documentation":"A unique identifier that is used by third parties to assume a role in their customers' accounts. For each role that the third party can assume, they should instruct their customers to create a role with the external ID that the third party generated. Each time the third party assumes the role, they must pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see About the External ID in Using Temporary Security Credentials.
" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an \"access denied\" error.
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
" - }, - "AssumedRoleUser":{ - "shape":"AssumedRoleUser", - "documentation":"The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
" - } - }, - "documentation":"Contains the result of a successful call to the AssumeRole action, including temporary AWS credentials that can be used to make AWS requests.
" - }, - "AssumeRoleWithSAMLRequest":{ - "type":"structure", - "required":[ - "RoleArn", - "PrincipalArn", - "SAMLAssertion" - ], - "members":{ - "RoleArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the role that the caller is assuming.
" - }, - "PrincipalArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
" - }, - "SAMLAssertion":{ - "shape":"SAMLAssertionType", - "documentation":"The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
" - }, - "Policy":{ - "shape":"sessionPolicyDocumentType", - "documentation":"An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithSAML in Using Temporary Security Credentials.
" - }, - "DurationSeconds":{ - "shape":"durationSecondsType", - "documentation":"The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's NotOnOrAfter value. The actual expiration time is whichever value is shorter.
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
" - }, - "Subject":{ - "shape":"Subject", - "documentation":"The value of the NameID element in the Subject element of the SAML assertion.
The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.
If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.
The value of the Issuer element of the SAML assertion.
The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )
Contains the result of a successful call to the AssumeRoleWithSAML action, including temporary AWS credentials that can be used to make AWS requests.
" - }, - "AssumeRoleWithWebIdentityRequest":{ - "type":"structure", - "required":[ - "RoleArn", - "RoleSessionName", - "WebIdentityToken" - ], - "members":{ - "RoleArn":{ - "shape":"arnType", - "documentation":"The Amazon Resource Name (ARN) of the role that the caller is assuming.
" - }, - "RoleSessionName":{ - "shape":"userNameType", - "documentation":"An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.
The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.
The fully-qualified host component of the domain name of the identity provider. Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens, such as accounts.google.com. Do not include URL schemes and port numbers. Currently, www.amazon.com and graph.facebook.com are supported.
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in Using Temporary Security Credentials.
" - }, - "DurationSeconds":{ - "shape":"durationSecondsType", - "documentation":"The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
" - } - } - }, - "AssumeRoleWithWebIdentityResponse":{ - "type":"structure", - "members":{ - "Credentials":{ - "shape":"Credentials", - "documentation":"The temporary security credentials, which include an access key ID, a secret access key, and a security token.
" - }, - "SubjectFromWebIdentityToken":{ - "shape":"webIdentitySubjectType", - "documentation":"The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). If an OpenID Connect ID token was submitted in the WebIdentityToken, this value is returned by the identity provider as the token's sub (Subject) claim.
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
" - }, - "Provider":{ - "shape":"Issuer", - "documentation":" The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the iss field. For OAuth 2.0 Access Tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
The intended audience of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
" - } - }, - "documentation":"Contains the result of a successful call to the AssumeRoleWithWebIdentity action, including temporary AWS credentials that can be used to make AWS requests.
" - }, - "AssumedRoleUser":{ - "type":"structure", - "required":[ - "AssumedRoleId", - "Arn" - ], - "members":{ - "AssumedRoleId":{ - "shape":"assumedRoleIdType", - "documentation":"A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.
" - } - }, - "documentation":"The identifiers for the temporary security credentials that the operation returns.
" - }, - "Audience":{"type":"string"}, - "Credentials":{ - "type":"structure", - "required":[ - "AccessKeyId", - "SecretAccessKey", - "SessionToken", - "Expiration" - ], - "members":{ - "AccessKeyId":{ - "shape":"accessKeyIdType", - "documentation":"The access key ID that identifies the temporary security credentials.
" - }, - "SecretAccessKey":{ - "shape":"accessKeySecretType", - "documentation":"The secret access key that can be used to sign requests.
" - }, - "SessionToken":{ - "shape":"tokenType", - "documentation":"The token that users must pass to the service API to use the temporary credentials.
" - }, - "Expiration":{ - "shape":"dateType", - "documentation":"The date on which the current credentials expire.
" - } - }, - "documentation":"AWS credentials for API authentication.
" - }, - "DecodeAuthorizationMessageRequest":{ - "type":"structure", - "required":["EncodedMessage"], - "members":{ - "EncodedMessage":{ - "shape":"encodedMessageType", - "documentation":"The encoded message that was returned with the response.
" - } - } - }, - "DecodeAuthorizationMessageResponse":{ - "type":"structure", - "members":{ - "DecodedMessage":{ - "shape":"decodedMessageType", - "documentation":"An XML document that contains the decoded message. For more information, see DecodeAuthorizationMessage.
A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request.
" - }, - "ExpiredTokenException":{ - "type":"structure", - "members":{ - "message":{"shape":"expiredIdentityTokenMessage"} - }, - "error":{ - "code":"ExpiredTokenException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.
" - }, - "FederatedUser":{ - "type":"structure", - "required":[ - "FederatedUserId", - "Arn" - ], - "members":{ - "FederatedUserId":{ - "shape":"federatedIdType", - "documentation":"The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.
" - }, - "Arn":{ - "shape":"arnType", - "documentation":"The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.
" - } - }, - "documentation":"Identifiers for the federated user that is associated with the credentials.
" - }, - "GetFederationTokenRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"userNameType", - "documentation":"The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.
An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials.
" - }, - "DurationSeconds":{ - "shape":"durationSecondsType", - "documentation":"The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
" - } - } - }, - "GetFederationTokenResponse":{ - "type":"structure", - "members":{ - "Credentials":{ - "shape":"Credentials", - "documentation":"Credentials for the service API authentication.
" - }, - "FederatedUser":{ - "shape":"FederatedUser", - "documentation":"Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.
A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
" - } - }, - "documentation":"Contains the result of a successful call to the GetFederationToken action, including temporary AWS credentials that can be used to make AWS requests.
" - }, - "GetSessionTokenRequest":{ - "type":"structure", - "members":{ - "DurationSeconds":{ - "shape":"durationSecondsType", - "documentation":"The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.
" - }, - "SerialNumber":{ - "shape":"serialNumberType", - "documentation":"The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.
The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an \"access denied\" response when requesting resources that require MFA authentication.
" - } - } - }, - "GetSessionTokenResponse":{ - "type":"structure", - "members":{ - "Credentials":{ - "shape":"Credentials", - "documentation":"The session credentials for API authentication.
" - } - }, - "documentation":"Contains the result of a successful call to the GetSessionToken action, including temporary AWS credentials that can be used to make AWS requests.
" - }, - "IDPCommunicationErrorException":{ - "type":"structure", - "members":{ - "message":{"shape":"idpCommunicationErrorMessage"} - }, - "error":{ - "code":"IDPCommunicationError", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.
" - }, - "IDPRejectedClaimException":{ - "type":"structure", - "members":{ - "message":{"shape":"idpRejectedClaimMessage"} - }, - "error":{ - "code":"IDPRejectedClaim", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.
If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.
The error message associated with the error.
" - } - }, - "error":{ - "code":"InvalidAuthorizationMessageException", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.
The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.
" - }, - "Issuer":{"type":"string"}, - "MalformedPolicyDocumentException":{ - "type":"structure", - "members":{ - "message":{"shape":"malformedPolicyDocumentMessage"} - }, - "error":{ - "code":"MalformedPolicyDocument", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was malformed. The error message describes the specific error.
" - }, - "NameQualifier":{"type":"string"}, - "PackedPolicyTooLargeException":{ - "type":"structure", - "members":{ - "message":{"shape":"packedPolicyTooLargeMessage"} - }, - "error":{ - "code":"PackedPolicyTooLarge", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.
" - }, - "SAMLAssertionType":{ - "type":"string", - "min":4, - "max":50000 - }, - "Subject":{"type":"string"}, - "SubjectType":{"type":"string"}, - "accessKeyIdType":{ - "type":"string", - "min":16, - "max":32, - "pattern":"[\\w]*" - }, - "accessKeySecretType":{"type":"string"}, - "arnType":{ - "type":"string", - "min":20, - "max":2048 - }, - "assumedRoleIdType":{ - "type":"string", - "min":2, - "max":96, - "pattern":"[\\w+=,.@:-]*" - }, - "clientTokenType":{ - "type":"string", - "min":4, - "max":2048 - }, - "dateType":{"type":"timestamp"}, - "decodedMessageType":{"type":"string"}, - "durationSecondsType":{ - "type":"integer", - "min":900, - "max":129600 - }, - "encodedMessageType":{ - "type":"string", - "min":1, - "max":10240 - }, - "expiredIdentityTokenMessage":{"type":"string"}, - "externalIdType":{ - "type":"string", - "min":2, - "max":96, - "pattern":"[\\w+=,.@:-]*" - }, - "federatedIdType":{ - "type":"string", - "min":2, - "max":96, - "pattern":"[\\w+=,.@\\:-]*" - }, - "idpCommunicationErrorMessage":{"type":"string"}, - "idpRejectedClaimMessage":{"type":"string"}, - "invalidAuthorizationMessage":{"type":"string"}, - "invalidIdentityTokenMessage":{"type":"string"}, - "malformedPolicyDocumentMessage":{"type":"string"}, - "nonNegativeIntegerType":{ - "type":"integer", - "min":0 - }, - "packedPolicyTooLargeMessage":{"type":"string"}, - "roleDurationSecondsType":{ - "type":"integer", - "min":900, - "max":3600 - }, - "serialNumberType":{ - "type":"string", - "min":9, - "max":256, - "pattern":"[\\w+=/:,.@-]*" - }, - "sessionPolicyDocumentType":{ - "type":"string", - "min":1, - "max":2048, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" - }, - "tokenCodeType":{ - "type":"string", - "min":6, - "max":6, - "pattern":"[\\d]*" - }, - "tokenType":{"type":"string"}, - "urlType":{ - "type":"string", - "min":4, - "max":2048 - }, - "userNameType":{ - "type":"string", - "min":2, - "max":32, - "pattern":"[\\w+=,.@-]*" - }, - "webIdentitySubjectType":{ - "type":"string", - "min":6, - "max":255 - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/support/2013-04-15.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/support/2013-04-15.normal.json deleted file mode 100644 index 1d7d998bf2..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/support/2013-04-15.normal.json +++ /dev/null @@ -1,1379 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2013-04-15", - "endpointPrefix":"support", - "jsonVersion":"1.1", - "serviceFullName":"AWS Support", - "signatureVersion":"v4", - "targetPrefix":"AWSSupport_20130415", - "protocol":"json" - }, - "documentation":"The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the AWS Support case management operations:
The following list describes the operations available from the AWS Support service for Trusted Advisor:
CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.For authentication of requests, AWS Support uses Signature Version 4 Signing Process.
See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
", - "operations":{ - "AddAttachmentsToSet":{ - "name":"AddAttachmentsToSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddAttachmentsToSetRequest"}, - "output":{ - "shape":"AddAttachmentsToSetResponse", - "documentation":"The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - { - "shape":"AttachmentSetIdNotFound", - "exception":true, - "documentation":"An attachment set with the specified ID could not be found.
" - }, - { - "shape":"AttachmentSetExpired", - "exception":true, - "documentation":"The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
" - }, - { - "shape":"AttachmentSetSizeLimitExceeded", - "exception":true, - "documentation":"A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
" - }, - { - "shape":"AttachmentLimitExceeded", - "exception":true, - "documentation":"The limit for the number of attachment sets created in a short period of time has been exceeded.
" - } - ], - "documentation":"Adds one or more attachments to an attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.
An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.
To be written.
" - }, - "output":{ - "shape":"AddCommunicationToCaseResponse", - "documentation":"The result of the AddCommunicationToCase operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - { - "shape":"CaseIdNotFound", - "exception":true, - "documentation":"The requested CaseId could not be located.
An attachment set with the specified ID could not be found.
" - }, - { - "shape":"AttachmentSetExpired", - "exception":true, - "documentation":"The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
" - } - ], - "documentation":"Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.
The response indicates the success or failure of the request.
This operation implements a subset of the features of the AWS Support Center.
" - }, - "CreateCase":{ - "name":"CreateCase", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateCaseRequest"}, - "output":{ - "shape":"CreateCaseResponse", - "documentation":"The AWS Support case ID returned by a successful completion of the CreateCase operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - { - "shape":"CaseCreationLimitExceeded", - "exception":true, - "documentation":"The case creation limit for the account has been exceeded.
" - }, - { - "shape":"AttachmentSetIdNotFound", - "exception":true, - "documentation":"An attachment set with the specified ID could not be found.
" - }, - { - "shape":"AttachmentSetExpired", - "exception":true, - "documentation":"The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
" - } - ], - "documentation":"Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
ServiceCode by calling DescribeServices. ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. To add additional communication or attachments to an existing case, use AddCommunicationToCase.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.
" - }, - "DescribeAttachment":{ - "name":"DescribeAttachment", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeAttachmentRequest"}, - "output":{ - "shape":"DescribeAttachmentResponse", - "documentation":"The content and file name of the attachment returned by the DescribeAttachment operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - { - "shape":"DescribeAttachmentLimitExceeded", - "exception":true, - "documentation":"The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
" - }, - { - "shape":"AttachmentIdNotFound", - "exception":true, - "documentation":"An attachment with the specified ID could not be found.
" - } - ], - "documentation":"Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
" - }, - "DescribeCases":{ - "name":"DescribeCases", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeCasesRequest"}, - "output":{ - "shape":"DescribeCasesResponse", - "documentation":"Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.
An internal server error occurred.
" - }, - { - "shape":"CaseIdNotFound", - "exception":true, - "documentation":"The requested CaseId could not be located.
Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
The response returns the following in JSON format:
NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.The communications returned by the DescribeCommunications operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - { - "shape":"CaseIdNotFound", - "exception":true, - "documentation":"The requested CaseId could not be located.
Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the MaxResults and NextToken parameters to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.
The list of AWS services returned by the DescribeServices operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.
The list of severity levels returned by the DescribeSeverityLevels operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
" - }, - "DescribeTrustedAdvisorCheckRefreshStatuses":{ - "name":"DescribeTrustedAdvisorCheckRefreshStatuses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"}, - "output":{ - "shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse", - "documentation":"The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
" - }, - "DescribeTrustedAdvisorCheckResult":{ - "name":"DescribeTrustedAdvisorCheckResult", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"}, - "output":{ - "shape":"DescribeTrustedAdvisorCheckResultResponse", - "documentation":"The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains an array of TrustedAdvisorCheckSummary objects.
" - }, - "DescribeTrustedAdvisorChecks":{ - "name":"DescribeTrustedAdvisorChecks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeTrustedAdvisorChecksRequest"}, - "output":{ - "shape":"DescribeTrustedAdvisorChecksResponse", - "documentation":"Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.
" - }, - "RefreshTrustedAdvisorCheck":{ - "name":"RefreshTrustedAdvisorCheck", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RefreshTrustedAdvisorCheckRequest"}, - "output":{ - "shape":"RefreshTrustedAdvisorCheckResponse", - "documentation":"The current refresh status of a Trusted Advisor check.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - } - ], - "documentation":"Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:
The status of the case returned by the ResolveCase operation.
" - }, - "errors":[ - { - "shape":"InternalServerError", - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - { - "shape":"CaseIdNotFound", - "exception":true, - "documentation":"The requested CaseId could not be located.
Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.
The ID of the attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.
One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.
" - } - } - }, - "AddAttachmentsToSetResponse":{ - "type":"structure", - "members":{ - "attachmentSetId":{ - "shape":"AttachmentSetId", - "documentation":"The ID of the attachment set. If an AttachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId was specified, the attachments are added to the specified set, if it exists.
The time and date when the attachment set expires.
" - } - }, - "documentation":"The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
" - }, - "AddCommunicationToCaseRequest":{ - "type":"structure", - "required":["communicationBody"], - "members":{ - "caseId":{ - "shape":"CaseId", - "documentation":"The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" - }, - "communicationBody":{ - "shape":"CommunicationBody", - "documentation":"The body of an email communication to add to the support case.
" - }, - "ccEmailAddresses":{ - "shape":"CcEmailAddressList", - "documentation":"The email addresses in the CC line of an email to be added to the support case.
" - }, - "attachmentSetId":{ - "shape":"AttachmentSetId", - "documentation":"The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
" - } - }, - "documentation":"To be written.
" - }, - "AddCommunicationToCaseResponse":{ - "type":"structure", - "members":{ - "result":{ - "shape":"Result", - "documentation":"True if AddCommunicationToCase succeeds. Otherwise, returns an error.
" - } - }, - "documentation":"The result of the AddCommunicationToCase operation.
" - }, - "AfterTime":{"type":"string"}, - "Attachment":{ - "type":"structure", - "members":{ - "fileName":{ - "shape":"FileName", - "documentation":"The name of the attachment file.
" - }, - "data":{ - "shape":"Data", - "documentation":"The content of the attachment file.
" - } - }, - "documentation":"An attachment to a case communication. The attachment consists of the file name and the content of the file.
" - }, - "AttachmentDetails":{ - "type":"structure", - "members":{ - "attachmentId":{ - "shape":"AttachmentId", - "documentation":"The ID of the attachment.
" - }, - "fileName":{ - "shape":"FileName", - "documentation":"The file name of the attachment.
" - } - }, - "documentation":"The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
" - }, - "AttachmentId":{"type":"string"}, - "AttachmentIdNotFound":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"An attachment with the specified ID could not be found.
" - } - }, - "exception":true, - "documentation":"An attachment with the specified ID could not be found.
" - }, - "AttachmentLimitExceeded":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"The limit for the number of attachment sets created in a short period of time has been exceeded.
" - } - }, - "exception":true, - "documentation":"The limit for the number of attachment sets created in a short period of time has been exceeded.
" - }, - "AttachmentSet":{ - "type":"list", - "member":{"shape":"AttachmentDetails"} - }, - "AttachmentSetExpired":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
" - } - }, - "exception":true, - "documentation":"The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
" - }, - "AttachmentSetId":{"type":"string"}, - "AttachmentSetIdNotFound":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"An attachment set with the specified ID could not be found.
" - } - }, - "exception":true, - "documentation":"An attachment set with the specified ID could not be found.
" - }, - "AttachmentSetSizeLimitExceeded":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
" - } - }, - "exception":true, - "documentation":"A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
" - }, - "Attachments":{ - "type":"list", - "member":{"shape":"Attachment"} - }, - "BeforeTime":{"type":"string"}, - "Boolean":{"type":"boolean"}, - "CaseCreationLimitExceeded":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"An error message that indicates that you have exceeded the number of cases you can have open.
" - } - }, - "exception":true, - "documentation":"The case creation limit for the account has been exceeded.
" - }, - "CaseDetails":{ - "type":"structure", - "members":{ - "caseId":{ - "shape":"CaseId", - "documentation":"The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" - }, - "displayId":{ - "shape":"DisplayId", - "documentation":"The ID displayed for the case in the AWS Support Center. This is a numeric string.
" - }, - "subject":{ - "shape":"Subject", - "documentation":"The subject line for the case in the AWS Support Center.
" - }, - "status":{ - "shape":"Status", - "documentation":"The status of the case.
" - }, - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"The code for the AWS service returned by the call to DescribeServices.
" - }, - "categoryCode":{ - "shape":"CategoryCode", - "documentation":"The category of problem for the AWS Support case.
" - }, - "severityCode":{ - "shape":"SeverityCode", - "documentation":"The code for the severity level returned by the call to DescribeSeverityLevels.
" - }, - "submittedBy":{ - "shape":"SubmittedBy", - "documentation":"The email address of the account that submitted the case.
" - }, - "timeCreated":{ - "shape":"TimeCreated", - "documentation":"The time that the case was case created in the AWS Support Center.
" - }, - "recentCommunications":{ - "shape":"RecentCaseCommunications", - "documentation":"The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.
The email addresses that receive copies of communication about the case.
" - }, - "language":{ - "shape":"Language", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - } - }, - "documentation":"A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:
Attachments, Body, CaseId, SubmittedBy, and TimeCreated.The requested CaseId could not be located.
The requested CaseId could not be located.
The category code for the support case.
" - }, - "name":{ - "shape":"CategoryName", - "documentation":"The category name for the support case.
" - } - }, - "documentation":"A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.
" - }, - "CategoryCode":{"type":"string"}, - "CategoryList":{ - "type":"list", - "member":{"shape":"Category"} - }, - "CategoryName":{"type":"string"}, - "CcEmailAddress":{"type":"string"}, - "CcEmailAddressList":{ - "type":"list", - "member":{"shape":"CcEmailAddress"} - }, - "Communication":{ - "type":"structure", - "members":{ - "caseId":{ - "shape":"CaseId", - "documentation":"The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" - }, - "body":{ - "shape":"CommunicationBody", - "documentation":"The text of the communication between the customer and AWS Support.
" - }, - "submittedBy":{ - "shape":"SubmittedBy", - "documentation":"The email address of the account that submitted the AWS Support case.
" - }, - "timeCreated":{ - "shape":"TimeCreated", - "documentation":"The time the communication was created.
" - }, - "attachmentSet":{ - "shape":"AttachmentSet", - "documentation":"Information about the attachments to the case communication.
" - } - }, - "documentation":"A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.
" - }, - "CommunicationBody":{"type":"string"}, - "CommunicationList":{ - "type":"list", - "member":{"shape":"Communication"} - }, - "CreateCaseRequest":{ - "type":"structure", - "required":[ - "subject", - "communicationBody" - ], - "members":{ - "subject":{ - "shape":"Subject", - "documentation":"The title of the AWS Support case.
" - }, - "serviceCode":{ - "shape":"ServiceCode", - "documentation":"The code for the AWS service returned by the call to DescribeServices.
" - }, - "severityCode":{ - "shape":"SeverityCode", - "documentation":"The code for the severity level returned by the call to DescribeSeverityLevels.
The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
The category of problem for the AWS Support case.
" - }, - "communicationBody":{ - "shape":"CommunicationBody", - "documentation":"The communication body text when you create an AWS Support case by calling CreateCase.
" - }, - "ccEmailAddresses":{ - "shape":"CcEmailAddressList", - "documentation":"A list of email addresses that AWS Support copies on case correspondence.
" - }, - "language":{ - "shape":"Language", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - }, - "issueType":{ - "shape":"IssueType", - "documentation":"The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"
" - }, - "attachmentSetId":{ - "shape":"AttachmentSetId", - "documentation":"The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.
" - } - } - }, - "CreateCaseResponse":{ - "type":"structure", - "members":{ - "caseId":{ - "shape":"CaseId", - "documentation":"The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" - } - }, - "documentation":"The AWS Support case ID returned by a successful completion of the CreateCase operation.
" - }, - "Data":{"type":"blob"}, - "DescribeAttachmentLimitExceeded":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
" - } - }, - "exception":true, - "documentation":"The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
" - }, - "DescribeAttachmentRequest":{ - "type":"structure", - "required":["attachmentId"], - "members":{ - "attachmentId":{ - "shape":"AttachmentId", - "documentation":"The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
" - } - } - }, - "DescribeAttachmentResponse":{ - "type":"structure", - "members":{ - "attachment":{ - "shape":"Attachment", - "documentation":"The attachment content and file name.
" - } - }, - "documentation":"The content and file name of the attachment returned by the DescribeAttachment operation.
" - }, - "DescribeCasesRequest":{ - "type":"structure", - "members":{ - "caseIdList":{ - "shape":"CaseIdList", - "documentation":"A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
" - }, - "displayId":{ - "shape":"DisplayId", - "documentation":"The ID displayed for a case in the AWS Support Center user interface.
" - }, - "afterTime":{ - "shape":"AfterTime", - "documentation":"The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" - }, - "beforeTime":{ - "shape":"BeforeTime", - "documentation":"The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" - }, - "includeResolvedCases":{ - "shape":"IncludeResolvedCases", - "documentation":"Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A resumption point for pagination.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return before paginating.
" - }, - "language":{ - "shape":"Language", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - }, - "includeCommunications":{ - "shape":"IncludeCommunications", - "documentation":"Specifies whether communications should be included in the DescribeCases results. The default is true.
" - } - } - }, - "DescribeCasesResponse":{ - "type":"structure", - "members":{ - "cases":{ - "shape":"CaseList", - "documentation":"The details for the cases that match the request.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A resumption point for pagination.
" - } - }, - "documentation":"Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.
The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" - }, - "beforeTime":{ - "shape":"BeforeTime", - "documentation":"The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" - }, - "afterTime":{ - "shape":"AfterTime", - "documentation":"The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A resumption point for pagination.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return before paginating.
" - } - } - }, - "DescribeCommunicationsResponse":{ - "type":"structure", - "members":{ - "communications":{ - "shape":"CommunicationList", - "documentation":"The communications for the case.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A resumption point for pagination.
" - } - }, - "documentation":"The communications returned by the DescribeCommunications operation.
" - }, - "DescribeServicesRequest":{ - "type":"structure", - "members":{ - "serviceCodeList":{ - "shape":"ServiceCodeList", - "documentation":"A JSON-formatted list of service codes available for AWS services.
" - }, - "language":{ - "shape":"Language", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - } - } - }, - "DescribeServicesResponse":{ - "type":"structure", - "members":{ - "services":{ - "shape":"ServiceList", - "documentation":"A JSON-formatted list of AWS services.
" - } - }, - "documentation":"The list of AWS services returned by the DescribeServices operation.
" - }, - "DescribeSeverityLevelsRequest":{ - "type":"structure", - "members":{ - "language":{ - "shape":"Language", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - } - } - }, - "DescribeSeverityLevelsResponse":{ - "type":"structure", - "members":{ - "severityLevels":{ - "shape":"SeverityLevelsList", - "documentation":"The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.
" - } - }, - "documentation":"The list of severity levels returned by the DescribeSeverityLevels operation.
" - }, - "DescribeTrustedAdvisorCheckRefreshStatusesRequest":{ - "type":"structure", - "required":["checkIds"], - "members":{ - "checkIds":{ - "shape":"StringList", - "documentation":"The IDs of the Trusted Advisor checks.
" - } - } - }, - "DescribeTrustedAdvisorCheckRefreshStatusesResponse":{ - "type":"structure", - "required":["statuses"], - "members":{ - "statuses":{ - "shape":"TrustedAdvisorCheckRefreshStatusList", - "documentation":"The refresh status of the specified Trusted Advisor checks.
" - } - }, - "documentation":"The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
" - }, - "DescribeTrustedAdvisorCheckResultRequest":{ - "type":"structure", - "required":["checkId"], - "members":{ - "checkId":{ - "shape":"String", - "documentation":"The unique identifier for the Trusted Advisor check.
" - }, - "language":{ - "shape":"String", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - } - } - }, - "DescribeTrustedAdvisorCheckResultResponse":{ - "type":"structure", - "members":{ - "result":{ - "shape":"TrustedAdvisorCheckResult", - "documentation":"The detailed results of the Trusted Advisor check.
" - } - }, - "documentation":"The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
" - }, - "DescribeTrustedAdvisorCheckSummariesRequest":{ - "type":"structure", - "required":["checkIds"], - "members":{ - "checkIds":{ - "shape":"StringList", - "documentation":"The IDs of the Trusted Advisor checks.
" - } - } - }, - "DescribeTrustedAdvisorCheckSummariesResponse":{ - "type":"structure", - "required":["summaries"], - "members":{ - "summaries":{ - "shape":"TrustedAdvisorCheckSummaryList", - "documentation":"The summary information for the requested Trusted Advisor checks.
" - } - }, - "documentation":"The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
" - }, - "DescribeTrustedAdvisorChecksRequest":{ - "type":"structure", - "required":["language"], - "members":{ - "language":{ - "shape":"String", - "documentation":"The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" - } - } - }, - "DescribeTrustedAdvisorChecksResponse":{ - "type":"structure", - "required":["checks"], - "members":{ - "checks":{ - "shape":"TrustedAdvisorCheckList", - "documentation":"Information about all available Trusted Advisor checks.
" - } - }, - "documentation":"Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
" - }, - "DisplayId":{"type":"string"}, - "Double":{"type":"double"}, - "ErrorMessage":{"type":"string"}, - "ExpiryTime":{"type":"string"}, - "FileName":{"type":"string"}, - "IncludeCommunications":{"type":"boolean"}, - "IncludeResolvedCases":{"type":"boolean"}, - "InternalServerError":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"An internal server error occurred.
" - } - }, - "exception":true, - "fault":true, - "documentation":"An internal server error occurred.
" - }, - "IssueType":{"type":"string"}, - "Language":{"type":"string"}, - "Long":{"type":"long"}, - "MaxResults":{ - "type":"integer", - "min":10, - "max":100 - }, - "NextToken":{"type":"string"}, - "RecentCaseCommunications":{ - "type":"structure", - "members":{ - "communications":{ - "shape":"CommunicationList", - "documentation":"The five most recent communications associated with the case.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A resumption point for pagination.
" - } - }, - "documentation":"The five most recent communications associated with the case.
" - }, - "RefreshTrustedAdvisorCheckRequest":{ - "type":"structure", - "required":["checkId"], - "members":{ - "checkId":{ - "shape":"String", - "documentation":"The unique identifier for the Trusted Advisor check.
" - } - } - }, - "RefreshTrustedAdvisorCheckResponse":{ - "type":"structure", - "required":["status"], - "members":{ - "status":{ - "shape":"TrustedAdvisorCheckRefreshStatus", - "documentation":"The current refresh status for a check, including the amount of time until the check is eligible for refresh.
" - } - }, - "documentation":"The current refresh status of a Trusted Advisor check.
" - }, - "ResolveCaseRequest":{ - "type":"structure", - "members":{ - "caseId":{ - "shape":"CaseId", - "documentation":"The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" - } - } - }, - "ResolveCaseResponse":{ - "type":"structure", - "members":{ - "initialCaseStatus":{ - "shape":"CaseStatus", - "documentation":"The status of the case when the ResolveCase request was sent.
" - }, - "finalCaseStatus":{ - "shape":"CaseStatus", - "documentation":"The status of the case after the ResolveCase request was processed.
" - } - }, - "documentation":"The status of the case returned by the ResolveCase operation.
" - }, - "Result":{"type":"boolean"}, - "Service":{ - "type":"structure", - "members":{ - "code":{ - "shape":"ServiceCode", - "documentation":"The code for an AWS service returned by the DescribeServices response. The Name element contains the corresponding friendly name.
The friendly name for an AWS service. The Code element contains the corresponding code.
A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.
" - } - }, - "documentation":"Information about an AWS service returned by the DescribeServices operation.
" - }, - "ServiceCode":{ - "type":"string", - "pattern":"[0-9a-z\\-_]+" - }, - "ServiceCodeList":{ - "type":"list", - "member":{"shape":"ServiceCode"}, - "min":0, - "max":100 - }, - "ServiceList":{ - "type":"list", - "member":{"shape":"Service"} - }, - "ServiceName":{"type":"string"}, - "SeverityCode":{"type":"string"}, - "SeverityLevel":{ - "type":"structure", - "members":{ - "code":{ - "shape":"SeverityLevelCode", - "documentation":"One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in SeverityLevel.name.
The name of the severity level that corresponds to the severity level code.
" - } - }, - "documentation":"A code and name pair that represent a severity level that can be applied to a support case.
" - }, - "SeverityLevelCode":{"type":"string"}, - "SeverityLevelName":{"type":"string"}, - "SeverityLevelsList":{ - "type":"list", - "member":{"shape":"SeverityLevel"} - }, - "Status":{"type":"string"}, - "String":{"type":"string"}, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, - "Subject":{"type":"string"}, - "SubmittedBy":{"type":"string"}, - "TimeCreated":{"type":"string"}, - "TrustedAdvisorCategorySpecificSummary":{ - "type":"structure", - "members":{ - "costOptimizing":{ - "shape":"TrustedAdvisorCostOptimizingSummary", - "documentation":"The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
" - } - }, - "documentation":"The container for summary information that relates to the category of the Trusted Advisor check.
" - }, - "TrustedAdvisorCheckDescription":{ - "type":"structure", - "required":[ - "id", - "name", - "description", - "category", - "metadata" - ], - "members":{ - "id":{ - "shape":"String", - "documentation":"The unique identifier for the Trusted Advisor check.
" - }, - "name":{ - "shape":"String", - "documentation":"The display name for the Trusted Advisor check.
" - }, - "description":{ - "shape":"String", - "documentation":"The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).
" - }, - "category":{ - "shape":"String", - "documentation":"The category of the Trusted Advisor check.
" - }, - "metadata":{ - "shape":"StringList", - "documentation":"The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
" - } - }, - "documentation":"The description and metadata for a Trusted Advisor check.
" - }, - "TrustedAdvisorCheckList":{ - "type":"list", - "member":{"shape":"TrustedAdvisorCheckDescription"} - }, - "TrustedAdvisorCheckRefreshStatus":{ - "type":"structure", - "required":[ - "checkId", - "status", - "millisUntilNextRefreshable" - ], - "members":{ - "checkId":{ - "shape":"String", - "documentation":"The unique identifier for the Trusted Advisor check.
" - }, - "status":{ - "shape":"String", - "documentation":"The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".
" - }, - "millisUntilNextRefreshable":{ - "shape":"Long", - "documentation":"The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
" - } - }, - "documentation":"The refresh status of a Trusted Advisor check.
" - }, - "TrustedAdvisorCheckRefreshStatusList":{ - "type":"list", - "member":{"shape":"TrustedAdvisorCheckRefreshStatus"} - }, - "TrustedAdvisorCheckResult":{ - "type":"structure", - "required":[ - "checkId", - "timestamp", - "status", - "resourcesSummary", - "categorySpecificSummary", - "flaggedResources" - ], - "members":{ - "checkId":{ - "shape":"String", - "documentation":"The unique identifier for the Trusted Advisor check.
" - }, - "timestamp":{ - "shape":"String", - "documentation":"The time of the last refresh of the check.
" - }, - "status":{ - "shape":"String", - "documentation":"The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".
" - }, - "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, - "categorySpecificSummary":{ - "shape":"TrustedAdvisorCategorySpecificSummary", - "documentation":"Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
" - }, - "flaggedResources":{ - "shape":"TrustedAdvisorResourceDetailList", - "documentation":"The details about each resource listed in the check result.
" - } - }, - "documentation":"The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
" - }, - "TrustedAdvisorCheckSummary":{ - "type":"structure", - "required":[ - "checkId", - "timestamp", - "status", - "resourcesSummary", - "categorySpecificSummary" - ], - "members":{ - "checkId":{ - "shape":"String", - "documentation":"The unique identifier for the Trusted Advisor check.
" - }, - "timestamp":{ - "shape":"String", - "documentation":"The time of the last refresh of the check.
" - }, - "status":{ - "shape":"String", - "documentation":"The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".
" - }, - "hasFlaggedResources":{ - "shape":"Boolean", - "documentation":"Specifies whether the Trusted Advisor check has flagged resources.
" - }, - "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, - "categorySpecificSummary":{ - "shape":"TrustedAdvisorCategorySpecificSummary", - "documentation":"Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
" - } - }, - "documentation":"A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
" - }, - "TrustedAdvisorCheckSummaryList":{ - "type":"list", - "member":{"shape":"TrustedAdvisorCheckSummary"} - }, - "TrustedAdvisorCostOptimizingSummary":{ - "type":"structure", - "required":[ - "estimatedMonthlySavings", - "estimatedPercentMonthlySavings" - ], - "members":{ - "estimatedMonthlySavings":{ - "shape":"Double", - "documentation":"The estimated monthly savings that might be realized if the recommended actions are taken.
" - }, - "estimatedPercentMonthlySavings":{ - "shape":"Double", - "documentation":"The estimated percentage of savings that might be realized if the recommended actions are taken.
" - } - }, - "documentation":"The estimated cost savings that might be realized if the recommended actions are taken.
" - }, - "TrustedAdvisorResourceDetail":{ - "type":"structure", - "required":[ - "status", - "region", - "resourceId", - "metadata" - ], - "members":{ - "status":{ - "shape":"String", - "documentation":"The status code for the resource identified in the Trusted Advisor check.
" - }, - "region":{ - "shape":"String", - "documentation":"The AWS region in which the identified resource is located.
" - }, - "resourceId":{ - "shape":"String", - "documentation":"The unique identifier for the identified resource.
" - }, - "isSuppressed":{ - "shape":"Boolean", - "documentation":"Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
" - }, - "metadata":{ - "shape":"StringList", - "documentation":"Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
" - } - }, - "documentation":"Contains information about a resource identified by a Trusted Advisor check.
" - }, - "TrustedAdvisorResourceDetailList":{ - "type":"list", - "member":{"shape":"TrustedAdvisorResourceDetail"} - }, - "TrustedAdvisorResourcesSummary":{ - "type":"structure", - "required":[ - "resourcesProcessed", - "resourcesFlagged", - "resourcesIgnored", - "resourcesSuppressed" - ], - "members":{ - "resourcesProcessed":{ - "shape":"Long", - "documentation":"The number of AWS resources that were analyzed by the Trusted Advisor check.
" - }, - "resourcesFlagged":{ - "shape":"Long", - "documentation":"The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
" - }, - "resourcesIgnored":{ - "shape":"Long", - "documentation":"The number of AWS resources ignored by Trusted Advisor because information was unavailable.
" - }, - "resourcesSuppressed":{ - "shape":"Long", - "documentation":"The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
" - } - }, - "documentation":"Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/support/2013-04-15.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/support/2013-04-15.paginators.json deleted file mode 100644 index 11bdb62cf1..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/support/2013-04-15.paginators.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "pagination": { - "DescribeCases": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "cases" - }, - "DescribeCommunications": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "communications" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/swf/2012-01-25.normal.json b/src/github.com/getlantern/aws-sdk-go/apis/swf/2012-01-25.normal.json deleted file mode 100644 index a98df8d932..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/swf/2012-01-25.normal.json +++ /dev/null @@ -1,4518 +0,0 @@ -{ - "metadata":{ - "apiVersion":"2012-01-25", - "endpointPrefix":"swf", - "jsonVersion":"1.0", - "serviceAbbreviation":"Amazon SWF", - "serviceFullName":"Amazon Simple Workflow Service", - "signatureVersion":"v4", - "targetPrefix":"SimpleWorkflowService", - "timestampFormat":"unixTimestamp", - "protocol":"json" - }, - "documentation":"The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.
", - "operations":{ - "CountClosedWorkflowExecutions":{ - "name":"CountClosedWorkflowExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CountClosedWorkflowExecutionsInput"}, - "output":{ - "shape":"WorkflowExecutionCount", - "documentation":"Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "CountOpenWorkflowExecutions":{ - "name":"CountOpenWorkflowExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CountOpenWorkflowExecutionsInput"}, - "output":{ - "shape":"WorkflowExecutionCount", - "documentation":"Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "CountPendingActivityTasks":{ - "name":"CountPendingActivityTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CountPendingActivityTasksInput"}, - "output":{ - "shape":"PendingTaskCount", - "documentation":"Contains the count of tasks in a task list.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "CountPendingDecisionTasks":{ - "name":"CountPendingDecisionTasks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CountPendingDecisionTasksInput"}, - "output":{ - "shape":"PendingTaskCount", - "documentation":"Contains the count of tasks in a task list.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DeprecateActivityType":{ - "name":"DeprecateActivityType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeprecateActivityTypeInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"TypeDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DeprecateDomain":{ - "name":"DeprecateDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeprecateDomainInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"DomainDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified domain has been deprecated.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DeprecateWorkflowType":{ - "name":"DeprecateWorkflowType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeprecateWorkflowTypeInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"TypeDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DescribeActivityType":{ - "name":"DescribeActivityType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeActivityTypeInput"}, - "output":{ - "shape":"ActivityTypeDetail", - "documentation":"Detailed information about an activity type.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DescribeDomain":{ - "name":"DescribeDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDomainInput"}, - "output":{ - "shape":"DomainDetail", - "documentation":"Contains details of a domain.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns information about the specified domain, including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DescribeWorkflowExecution":{ - "name":"DescribeWorkflowExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeWorkflowExecutionInput"}, - "output":{ - "shape":"WorkflowExecutionDetail", - "documentation":"Contains details about a workflow execution.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns information about the specified workflow execution including its type and some statistics.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "DescribeWorkflowType":{ - "name":"DescribeWorkflowType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeWorkflowTypeInput"}, - "output":{ - "shape":"WorkflowTypeDetail", - "documentation":"Contains details about a workflow type.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "GetWorkflowExecutionHistory":{ - "name":"GetWorkflowExecutionHistory", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetWorkflowExecutionHistoryInput"}, - "output":{ - "shape":"History", - "documentation":"Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ListActivityTypes":{ - "name":"ListActivityTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListActivityTypesInput"}, - "output":{ - "shape":"ActivityTypeInfos", - "documentation":"Contains a paginated list of activity type information structures.
" - }, - "errors":[ - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - } - ], - "documentation":"Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ListClosedWorkflowExecutions":{ - "name":"ListClosedWorkflowExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListClosedWorkflowExecutionsInput"}, - "output":{ - "shape":"WorkflowExecutionInfos", - "documentation":"Contains a paginated list of information about workflow executions.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ListDomains":{ - "name":"ListDomains", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDomainsInput"}, - "output":{ - "shape":"DomainInfos", - "documentation":"Contains a paginated collection of DomainInfo structures.
" - }, - "errors":[ - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ListOpenWorkflowExecutions":{ - "name":"ListOpenWorkflowExecutions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListOpenWorkflowExecutionsInput"}, - "output":{ - "shape":"WorkflowExecutionInfos", - "documentation":"Contains a paginated list of information about workflow executions.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ListWorkflowTypes":{ - "name":"ListWorkflowTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWorkflowTypesInput"}, - "output":{ - "shape":"WorkflowTypeInfos", - "documentation":"Contains a paginated list of information structures about workflow types.
" - }, - "errors":[ - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - } - ], - "documentation":"Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "PollForActivityTask":{ - "name":"PollForActivityTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PollForActivityTaskInput"}, - "output":{ - "shape":"ActivityTask", - "documentation":"Unit of work sent to an activity worker.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - } - ], - "documentation":"Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "PollForDecisionTask":{ - "name":"PollForDecisionTask", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PollForDecisionTaskInput"}, - "output":{ - "shape":"DecisionTask", - "documentation":"A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - } - ], - "documentation":"Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RecordActivityTaskHeartbeat":{ - "name":"RecordActivityTaskHeartbeat", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RecordActivityTaskHeartbeatInput"}, - "output":{ - "shape":"ActivityTaskStatus", - "documentation":"Status information about an activity task.
" - }, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.
This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.
This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.
taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RegisterActivityType":{ - "name":"RegisterActivityType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterActivityTypeInput"}, - "errors":[ - { - "shape":"TypeAlreadyExistsFault", - "exception":true, - "documentation":"Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Registers a new activity type along with its configuration settings in the specified domain.
TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RegisterDomain":{ - "name":"RegisterDomain", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterDomainInput"}, - "errors":[ - { - "shape":"DomainAlreadyExistsFault", - "exception":true, - "documentation":"Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RegisterWorkflowType":{ - "name":"RegisterWorkflowType", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RegisterWorkflowTypeInput"}, - "errors":[ - { - "shape":"TypeAlreadyExistsFault", - "exception":true, - "documentation":"Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RequestCancelWorkflowExecution":{ - "name":"RequestCancelWorkflowExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RequestCancelWorkflowExecutionInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RespondActivityTaskCanceled":{ - "name":"RespondActivityTaskCanceled", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RespondActivityTaskCanceledInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.
canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RespondActivityTaskCompleted":{ - "name":"RespondActivityTaskCompleted", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RespondActivityTaskCompletedInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.
canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RespondActivityTaskFailed":{ - "name":"RespondActivityTaskFailed", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RespondActivityTaskFailedInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RespondDecisionTaskCompleted":{ - "name":"RespondDecisionTaskCompleted", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RespondDecisionTaskCompletedInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "StartWorkflowExecution":{ - "name":"StartWorkflowExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartWorkflowExecutionInput"}, - "output":{ - "shape":"Run", - "documentation":"Specifies the runId of a workflow execution.
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"TypeDeprecatedFault", - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - { - "shape":"WorkflowExecutionAlreadyStartedFault", - "exception":true, - "documentation":"Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
" - }, - { - "shape":"LimitExceededFault", - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - { - "shape":"DefaultUndefinedFault", - "exception":true - } - ], - "documentation":"Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0.tagList.member.1: The key is swf:tagList.member.1.tagList.member.2: The key is swf:tagList.member.2.tagList.member.3: The key is swf:tagList.member.3.tagList.member.4: The key is swf:tagList.member.4.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "TerminateWorkflowExecution":{ - "name":"TerminateWorkflowExecution", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TerminateWorkflowExecutionInput"}, - "errors":[ - { - "shape":"UnknownResourceFault", - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - { - "shape":"OperationNotPermittedFault", - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - } - ], - "documentation":"Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - } - }, - "shapes":{ - "ActivityId":{ - "type":"string", - "min":1, - "max":256 - }, - "ActivityTask":{ - "type":"structure", - "required":[ - "taskToken", - "activityId", - "startedEventId", - "workflowExecution", - "activityType" - ], - "members":{ - "taskToken":{ - "shape":"TaskToken", - "documentation":"The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
" - }, - "activityId":{ - "shape":"ActivityId", - "documentation":"The unique ID of the task.
" - }, - "startedEventId":{ - "shape":"EventId", - "documentation":"The id of the ActivityTaskStarted event recorded in the history.
The workflow execution that started this activity task.
" - }, - "activityType":{ - "shape":"ActivityType", - "documentation":"The type of this activity task.
" - }, - "input":{ - "shape":"Data", - "documentation":"The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.
" - } - }, - "documentation":"Unit of work sent to an activity worker.
" - }, - "ActivityTaskCancelRequestedEventAttributes":{ - "type":"structure", - "required":[ - "decisionTaskCompletedEventId", - "activityId" - ], - "members":{ - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The unique ID of the task.
" - } - }, - "documentation":"Provides details of the ActivityTaskCancelRequested event.
Details of the cancellation (if any).
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
If set, contains the Id of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskCanceled event.
The results of the activity task (if any).
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskCompleted event.
The reason provided for the failure (if any).
" - }, - "details":{ - "shape":"Data", - "documentation":"The details of the failure (if any).
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskFailed event.
The type of the activity task.
" - }, - "activityId":{ - "shape":"ActivityId", - "documentation":"The unique id of the activity task.
" - }, - "input":{ - "shape":"Data", - "documentation":"The input provided to the activity task.
" - }, - "control":{ - "shape":"Data", - "documentation":"Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
" - }, - "scheduleToStartTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum amount of time the activity task can wait to be assigned to a worker.
" - }, - "scheduleToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum amount of time for this activity task.
" - }, - "startToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum amount of time a worker may take to process the activity task.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"The task list in which the activity task has been scheduled.
" - }, - "taskPriority":{ - "shape":"TaskPriority", - "documentation":"Optional. The priority to assign to the scheduled activity task. This will override any default priority that was assigned when the activity type was registered. If not set, then the priority set on the activity type is used as the task priority.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.
" - } - }, - "documentation":"Provides details of the ActivityTaskScheduled event.
Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ActivityTaskStarted event.
Set to true if cancellation of the task is requested.
Status information about an activity task.
" - }, - "ActivityTaskTimedOutEventAttributes":{ - "type":"structure", - "required":[ - "timeoutType", - "scheduledEventId", - "startedEventId" - ], - "members":{ - "timeoutType":{ - "shape":"ActivityTaskTimeoutType", - "documentation":"The type of the timeout that caused this event.
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.
Provides details of the ActivityTaskTimedOut event.
The name of this activity.
The version of this activity.
Represents an activity type.
" - }, - "ActivityTypeConfiguration":{ - "type":"structure", - "members":{ - "defaultTaskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskHeartbeatTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskList":{ - "shape":"TaskList", - "documentation":"Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.
Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then \"0\" will be used as the default priority. This default can be overridden when scheduling an activity task.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "defaultTaskScheduleToStartTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskScheduleToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - } - }, - "documentation":"Configuration settings registered with the activity type.
" - }, - "ActivityTypeDetail":{ - "type":"structure", - "required":[ - "typeInfo", - "configuration" - ], - "members":{ - "typeInfo":{ - "shape":"ActivityTypeInfo", - "documentation":"General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
The configuration settings registered with the activity type.
" - } - }, - "documentation":"Detailed information about an activity type.
" - }, - "ActivityTypeInfo":{ - "type":"structure", - "required":[ - "activityType", - "status", - "creationDate" - ], - "members":{ - "activityType":{ - "shape":"ActivityType", - "documentation":"The ActivityType type structure representing the activity type.
" - }, - "status":{ - "shape":"RegistrationStatus", - "documentation":"The current status of the activity type.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the activity type provided in RegisterActivityType.
" - }, - "creationDate":{ - "shape":"Timestamp", - "documentation":"The date and time this activity type was created through RegisterActivityType.
" - }, - "deprecationDate":{ - "shape":"Timestamp", - "documentation":"If DEPRECATED, the date and time DeprecateActivityType was called.
" - } - }, - "documentation":"Detailed information about an activity type.
" - }, - "ActivityTypeInfoList":{ - "type":"list", - "member":{"shape":"ActivityTypeInfo"} - }, - "ActivityTypeInfos":{ - "type":"structure", - "required":["typeInfos"], - "members":{ - "typeInfos":{ - "shape":"ActivityTypeInfoList", - "documentation":"List of activity type information.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Contains a paginated list of activity type information structures.
" - }, - "CancelTimerDecisionAttributes":{ - "type":"structure", - "required":["timerId"], - "members":{ - "timerId":{ - "shape":"TimerId", - "documentation":"Required. The unique Id of the timer to cancel.
" - } - }, - "documentation":"Provides details of the CancelTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "CancelTimerFailedCause":{ - "type":"string", - "enum":[ - "TIMER_ID_UNKNOWN", - "OPERATION_NOT_PERMITTED" - ] - }, - "CancelTimerFailedEventAttributes":{ - "type":"structure", - "required":[ - "timerId", - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "timerId":{ - "shape":"TimerId", - "documentation":"The timerId provided in the CancelTimer decision that failed.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the CancelTimerFailed event.
Optional. details of the cancellation.
" - } - }, - "documentation":"Provides details of the CancelWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "CancelWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "UNHANDLED_DECISION", - "OPERATION_NOT_PERMITTED" - ] - }, - "CancelWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "cause":{ - "shape":"CancelWorkflowExecutionFailedCause", - "documentation":"The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the CancelWorkflowExecutionFailed event.
The child workflow execution that was canceled.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the child workflow execution.
" - }, - "details":{ - "shape":"Data", - "documentation":"Details of the cancellation (if provided).
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provide details of the ChildWorkflowExecutionCanceled event.
The child workflow execution that was completed.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the child workflow execution.
" - }, - "result":{ - "shape":"Data", - "documentation":"The result of the child workflow execution (if any).
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionCompleted event.
The child workflow execution that failed.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the child workflow execution.
" - }, - "reason":{ - "shape":"FailureReason", - "documentation":"The reason for the failure (if provided).
" - }, - "details":{ - "shape":"Data", - "documentation":"The details of the failure (if provided).
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionFailed event.
The child workflow execution that was started.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the child workflow execution.
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionStarted event.
The child workflow execution that was terminated.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the child workflow execution.
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionTerminated event.
The child workflow execution that timed out.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the child workflow execution.
" - }, - "timeoutType":{ - "shape":"WorkflowExecutionTimeoutType", - "documentation":"The type of the timeout that caused the child workflow execution to time out.
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ChildWorkflowExecutionTimedOut event.
Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.
" - } - }, - "documentation":"Used to filter the closed workflow executions in visibility APIs by their close status.
" - }, - "CompleteWorkflowExecutionDecisionAttributes":{ - "type":"structure", - "members":{ - "result":{ - "shape":"Data", - "documentation":"The result of the workflow execution. The form of the result is implementation defined.
" - } - }, - "documentation":"Provides details of the CompleteWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "CompleteWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "UNHANDLED_DECISION", - "OPERATION_NOT_PERMITTED" - ] - }, - "CompleteWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "cause":{ - "shape":"CompleteWorkflowExecutionFailedCause", - "documentation":"The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the CompleteWorkflowExecutionFailed event.
The input provided to the new workflow execution.
" - }, - "executionStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "taskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
" - }, - "workflowTypeVersion":{"shape":"Version"} - }, - "documentation":"Provides details of the ContinueAsNewWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tag: Optional.. A tag used to identify the workflow executiontaskList: String constraint. The key is swf:taskList.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ContinueAsNewWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "UNHANDLED_DECISION", - "WORKFLOW_TYPE_DEPRECATED", - "WORKFLOW_TYPE_DOES_NOT_EXIST", - "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", - "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", - "DEFAULT_TASK_LIST_UNDEFINED", - "DEFAULT_CHILD_POLICY_UNDEFINED", - "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", - "OPERATION_NOT_PERMITTED" - ] - }, - "ContinueAsNewWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "cause":{ - "shape":"ContinueAsNewWorkflowExecutionFailedCause", - "documentation":"The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ContinueAsNewWorkflowExecutionFailed event.
The name of the domain containing the workflow executions to count.
" - }, - "startTimeFilter":{ - "shape":"ExecutionTimeFilter", - "documentation":"If specified, only workflow executions that meet the start time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, only workflow executions that meet the close time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, only workflow executions matching the WorkflowId in the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, indicates the type of the workflow executions to be counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have a tag that matches the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.The name of the domain containing the workflow executions to count.
" - }, - "startTimeFilter":{ - "shape":"ExecutionTimeFilter", - "documentation":"Specifies the start time criteria that workflow executions must meet in order to be counted.
" - }, - "typeFilter":{ - "shape":"WorkflowTypeFilter", - "documentation":"Specifies the type of the workflow executions to be counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have a tag that matches the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the WorkflowId in the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.The name of the domain that contains the task list.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"The name of the task list.
" - } - } - }, - "CountPendingDecisionTasksInput":{ - "type":"structure", - "required":[ - "domain", - "taskList" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain that contains the task list.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"The name of the task list.
" - } - } - }, - "Data":{ - "type":"string", - "max":32768 - }, - "Decision":{ - "type":"structure", - "required":["decisionType"], - "members":{ - "decisionType":{ - "shape":"DecisionType", - "documentation":"Specifies the type of the decision.
" - }, - "scheduleActivityTaskDecisionAttributes":{ - "shape":"ScheduleActivityTaskDecisionAttributes", - "documentation":"Provides details of the ScheduleActivityTask decision. It is not set for other decision types.
Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.
Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.
Provides details of the FailWorkflowExecution decision. It is not set for other decision types.
Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.
Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.
Provides details of the RecordMarker decision. It is not set for other decision types.
Provides details of the StartTimer decision. It is not set for other decision types.
Provides details of the CancelTimer decision. It is not set for other decision types.
Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.
Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.
Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.
Specifies a decision made by the decider. A decision can be one of these types:
TimerCanceled event in the history.WorkflowExecutionCanceled event in the history.WorkflowExecutionCompleted event in the history .WorkflowExecutionContinuedAsNew event is recorded in the history.WorkflowExecutionFailed event in the history.MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.RequestCancelExternalWorkflowExecutionInitiated event in the history.SignalExternalWorkflowExecutionInitiated event in the history.StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.Access Control
If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Decision Failure
Decisions can fail for several reasons
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
workflowID specified in the decision was incorrect.workflowID specified in the decision was incorrect.The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.How to Code a Decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
" - }, - "startedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskStarted event recorded in the history.
The workflow execution for which this decision task was created.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the workflow execution for which this decision task was created.
" - }, - "events":{ - "shape":"HistoryEventList", - "documentation":"A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The id of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.
" - } - }, - "documentation":"A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
" - }, - "DecisionTaskCompletedEventAttributes":{ - "type":"structure", - "required":[ - "scheduledEventId", - "startedEventId" - ], - "members":{ - "executionContext":{ - "shape":"Data", - "documentation":"User defined context for the workflow execution.
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the DecisionTaskCompleted event.
The name of the task list in which the decision task was scheduled.
" - }, - "taskPriority":{ - "shape":"TaskPriority", - "documentation":"Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "startToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - } - }, - "documentation":"Provides details about the DecisionTaskScheduled event.
Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the DecisionTaskStarted event.
The type of timeout that expired before the decision task could be completed.
" - }, - "scheduledEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The Id of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the DecisionTaskTimedOut event.
The name of the domain in which the activity type is registered.
" - }, - "activityType":{ - "shape":"ActivityType", - "documentation":"The activity type to deprecate.
" - } - } - }, - "DeprecateDomainInput":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"DomainName", - "documentation":"The name of the domain to deprecate.
" - } - } - }, - "DeprecateWorkflowTypeInput":{ - "type":"structure", - "required":[ - "domain", - "workflowType" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain in which the workflow type is registered.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The workflow type to deprecate.
" - } - } - }, - "DescribeActivityTypeInput":{ - "type":"structure", - "required":[ - "domain", - "activityType" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain in which the activity type is registered.
" - }, - "activityType":{ - "shape":"ActivityType", - "documentation":"The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.
The name of the domain to describe.
" - } - } - }, - "DescribeWorkflowExecutionInput":{ - "type":"structure", - "required":[ - "domain", - "execution" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain containing the workflow execution.
" - }, - "execution":{ - "shape":"WorkflowExecution", - "documentation":"The workflow execution to describe.
" - } - } - }, - "DescribeWorkflowTypeInput":{ - "type":"structure", - "required":[ - "domain", - "workflowType" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain in which this workflow type is registered.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The workflow type to describe.
" - } - } - }, - "Description":{ - "type":"string", - "max":1024 - }, - "DomainAlreadyExistsFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.
" - }, - "DomainConfiguration":{ - "type":"structure", - "required":["workflowExecutionRetentionPeriodInDays"], - "members":{ - "workflowExecutionRetentionPeriodInDays":{ - "shape":"DurationInDays", - "documentation":"The retention period for workflow executions in this domain.
" - } - }, - "documentation":"Contains the configuration settings of a domain.
" - }, - "DomainDeprecatedFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned when the specified domain has been deprecated.
" - }, - "DomainDetail":{ - "type":"structure", - "required":[ - "domainInfo", - "configuration" - ], - "members":{ - "domainInfo":{"shape":"DomainInfo"}, - "configuration":{"shape":"DomainConfiguration"} - }, - "documentation":"Contains details of a domain.
" - }, - "DomainInfo":{ - "type":"structure", - "required":[ - "name", - "status" - ], - "members":{ - "name":{ - "shape":"DomainName", - "documentation":"The name of the domain. This name is unique within the account.
" - }, - "status":{ - "shape":"RegistrationStatus", - "documentation":"The status of the domain:
The description of the domain provided through RegisterDomain.
" - } - }, - "documentation":"Contains general information about a domain.
" - }, - "DomainInfoList":{ - "type":"list", - "member":{"shape":"DomainInfo"} - }, - "DomainInfos":{ - "type":"structure", - "required":["domainInfos"], - "members":{ - "domainInfos":{ - "shape":"DomainInfoList", - "documentation":"A list of DomainInfo structures.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Contains a paginated collection of DomainInfo structures.
" - }, - "DomainName":{ - "type":"string", - "min":1, - "max":256 - }, - "DurationInDays":{ - "type":"string", - "min":1, - "max":8 - }, - "DurationInSeconds":{ - "type":"string", - "min":1, - "max":8 - }, - "DurationInSecondsOptional":{ - "type":"string", - "max":8 - }, - "ErrorMessage":{"type":"string"}, - "EventId":{"type":"long"}, - "EventType":{ - "type":"string", - "enum":[ - "WorkflowExecutionStarted", - "WorkflowExecutionCancelRequested", - "WorkflowExecutionCompleted", - "CompleteWorkflowExecutionFailed", - "WorkflowExecutionFailed", - "FailWorkflowExecutionFailed", - "WorkflowExecutionTimedOut", - "WorkflowExecutionCanceled", - "CancelWorkflowExecutionFailed", - "WorkflowExecutionContinuedAsNew", - "ContinueAsNewWorkflowExecutionFailed", - "WorkflowExecutionTerminated", - "DecisionTaskScheduled", - "DecisionTaskStarted", - "DecisionTaskCompleted", - "DecisionTaskTimedOut", - "ActivityTaskScheduled", - "ScheduleActivityTaskFailed", - "ActivityTaskStarted", - "ActivityTaskCompleted", - "ActivityTaskFailed", - "ActivityTaskTimedOut", - "ActivityTaskCanceled", - "ActivityTaskCancelRequested", - "RequestCancelActivityTaskFailed", - "WorkflowExecutionSignaled", - "MarkerRecorded", - "RecordMarkerFailed", - "TimerStarted", - "StartTimerFailed", - "TimerFired", - "TimerCanceled", - "CancelTimerFailed", - "StartChildWorkflowExecutionInitiated", - "StartChildWorkflowExecutionFailed", - "ChildWorkflowExecutionStarted", - "ChildWorkflowExecutionCompleted", - "ChildWorkflowExecutionFailed", - "ChildWorkflowExecutionTimedOut", - "ChildWorkflowExecutionCanceled", - "ChildWorkflowExecutionTerminated", - "SignalExternalWorkflowExecutionInitiated", - "SignalExternalWorkflowExecutionFailed", - "ExternalWorkflowExecutionSignaled", - "RequestCancelExternalWorkflowExecutionInitiated", - "RequestCancelExternalWorkflowExecutionFailed", - "ExternalWorkflowExecutionCancelRequested" - ] - }, - "ExecutionStatus":{ - "type":"string", - "enum":[ - "OPEN", - "CLOSED" - ] - }, - "ExecutionTimeFilter":{ - "type":"structure", - "required":["oldestDate"], - "members":{ - "oldestDate":{ - "shape":"Timestamp", - "documentation":"Specifies the oldest start or close date and time to return.
" - }, - "latestDate":{ - "shape":"Timestamp", - "documentation":"Specifies the latest start or close date and time to return.
" - } - }, - "documentation":"Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: \"oldestDate\": 1325376070.
The external workflow execution to which the cancellation request was delivered.
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ExternalWorkflowExecutionCancelRequested event.
The external workflow execution that the signal was delivered to.
" - }, - "initiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ExternalWorkflowExecutionSignaled event.
A descriptive reason for the failure that may help in diagnostics.
" - }, - "details":{ - "shape":"Data", - "documentation":"Optional. Details of the failure.
" - } - }, - "documentation":"Provides details of the FailWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "FailWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "UNHANDLED_DECISION", - "OPERATION_NOT_PERMITTED" - ] - }, - "FailWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "cause":{ - "shape":"FailWorkflowExecutionFailedCause", - "documentation":"The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the FailWorkflowExecutionFailed event.
The name of the domain containing the workflow execution.
" - }, - "execution":{ - "shape":"WorkflowExecution", - "documentation":"Specifies the workflow execution for which to return the history.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
The list of history events.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
" - }, - "HistoryEvent":{ - "type":"structure", - "required":[ - "eventTimestamp", - "eventType", - "eventId" - ], - "members":{ - "eventTimestamp":{ - "shape":"Timestamp", - "documentation":"The date and time when the event occurred.
" - }, - "eventType":{ - "shape":"EventType", - "documentation":"The type of the history event.
" - }, - "eventId":{ - "shape":"EventId", - "documentation":"The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.
" - }, - "workflowExecutionStartedEventAttributes":{ - "shape":"WorkflowExecutionStartedEventAttributes", - "documentation":"If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Event within a workflow execution. A history event can be one of these types:
RequestCancelActivityTask decision was received by the system.RecordMarker decision.StartTimer decision.A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
" - }, - "LimitedData":{ - "type":"string", - "max":2048 - }, - "ListActivityTypesInput":{ - "type":"structure", - "required":[ - "domain", - "registrationStatus" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain in which the activity types have been registered.
" - }, - "name":{ - "shape":"Name", - "documentation":"If specified, only lists the activity types that have this name.
" - }, - "registrationStatus":{ - "shape":"RegistrationStatus", - "documentation":"Specifies the registration status of the activity types to list.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.
The name of the domain that contains the workflow executions to list.
" - }, - "startTimeFilter":{ - "shape":"ExecutionTimeFilter", - "documentation":"If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, only workflow executions matching the workflow id specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions of the type specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have the matching tag are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Specifies the registration status of the domains to list.
" - }, - "maximumPageSize":{ - "shape":"PageSize", - "documentation":"The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.
The name of the domain that contains the workflow executions to list.
" - }, - "startTimeFilter":{ - "shape":"ExecutionTimeFilter", - "documentation":"Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
" - }, - "typeFilter":{ - "shape":"WorkflowTypeFilter", - "documentation":"If specified, only executions of the type specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.
If specified, only workflow executions matching the workflow id specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.The name of the domain in which the workflow types have been registered.
" - }, - "name":{ - "shape":"Name", - "documentation":"If specified, lists the workflow type with this name.
" - }, - "registrationStatus":{ - "shape":"RegistrationStatus", - "documentation":"Specifies the registration status of the workflow types to list.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.
The name of the marker.
" - }, - "details":{ - "shape":"Data", - "documentation":"Details of the marker (if any).
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the MarkerRecorded event.
A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned when the caller does not have sufficient permissions to invoke the action.
" - }, - "PageSize":{ - "type":"integer", - "min":0, - "max":1000 - }, - "PageToken":{ - "type":"string", - "max":2048 - }, - "PendingTaskCount":{ - "type":"structure", - "required":["count"], - "members":{ - "count":{ - "shape":"Count", - "documentation":"The number of tasks in the task list.
" - }, - "truncated":{ - "shape":"Truncated", - "documentation":"If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
" - } - }, - "documentation":"Contains the count of tasks in a task list.
" - }, - "PollForActivityTaskInput":{ - "type":"structure", - "required":[ - "domain", - "taskList" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain that contains the task lists being polled.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"Specifies the task list to poll for activity tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
The name of the domain containing the task lists to poll.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"Specifies the task list to poll for decision tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task.The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" - }, - "reverseOrder":{ - "shape":"ReverseOrder", - "documentation":"When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.
The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. If specified, contains details about the progress of the task.
" - } - } - }, - "RecordMarkerDecisionAttributes":{ - "type":"structure", - "required":["markerName"], - "members":{ - "markerName":{ - "shape":"MarkerName", - "documentation":"Required. The name of the marker.
" - }, - "details":{ - "shape":"Data", - "documentation":"Optional. details of the marker.
" - } - }, - "documentation":"Provides details of the RecordMarker decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RecordMarkerFailedCause":{ - "type":"string", - "enum":["OPERATION_NOT_PERMITTED"] - }, - "RecordMarkerFailedEventAttributes":{ - "type":"structure", - "required":[ - "markerName", - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "markerName":{ - "shape":"MarkerName", - "documentation":"The marker's name.
" - }, - "cause":{ - "shape":"RecordMarkerFailedCause", - "documentation":"The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the RecordMarkerFailed event.
The name of the domain in which this activity is to be registered.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the activity type within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The version of the activity type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
A textual description of the activity type.
" - }, - "defaultTaskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskHeartbeatTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskList":{ - "shape":"TaskList", - "documentation":"If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision.
The default task priority to assign to the activity type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "defaultTaskScheduleToStartTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskScheduleToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - } - } - }, - "RegisterDomainInput":{ - "type":"structure", - "required":[ - "name", - "workflowExecutionRetentionPeriodInDays" - ], - "members":{ - "name":{ - "shape":"DomainName", - "documentation":"Name of the domain to register. The name must be unique in the region that the domain is registered in.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
A text description of the domain.
" - }, - "workflowExecutionRetentionPeriodInDays":{ - "shape":"DurationInDays", - "documentation":"The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.
If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
" - } - } - }, - "RegisterWorkflowTypeInput":{ - "type":"structure", - "required":[ - "domain", - "name", - "version" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The name of the domain in which to register the workflow type.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The version of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Textual description of the workflow type.
" - }, - "defaultTaskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultExecutionStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The default task priority to assign to the workflow type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "defaultChildPolicy":{ - "shape":"ChildPolicy", - "documentation":"If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The activityId of the activity task to be canceled.
Provides details of the RequestCancelActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RequestCancelActivityTaskFailedCause":{ - "type":"string", - "enum":[ - "ACTIVITY_ID_UNKNOWN", - "OPERATION_NOT_PERMITTED" - ] - }, - "RequestCancelActivityTaskFailedEventAttributes":{ - "type":"structure", - "required":[ - "activityId", - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "activityId":{ - "shape":"ActivityId", - "documentation":"The activityId provided in the RequestCancelActivityTask decision that failed.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the RequestCancelActivityTaskFailed event.
Required. The workflowId of the external workflow execution to cancel.
The runId of the external workflow execution to cancel.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" - } - }, - "documentation":"Provides details of the RequestCancelExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "RequestCancelExternalWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", - "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", - "OPERATION_NOT_PERMITTED" - ] - }, - "RequestCancelExternalWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "workflowId", - "cause", - "initiatedEventId", - "decisionTaskCompletedEventId" - ], - "members":{ - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The workflowId of the external workflow to which the cancel request was to be delivered.
The runId of the external workflow execution.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the RequestCancelExternalWorkflowExecutionFailed event.
The workflowId of the external workflow execution to be canceled.
The runId of the external workflow execution to be canceled.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" - } - }, - "documentation":"Provides details of the RequestCancelExternalWorkflowExecutionInitiated event.
The name of the domain containing the workflow execution to cancel.
" - }, - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The workflowId of the workflow execution to cancel.
" - }, - "runId":{ - "shape":"RunIdOptional", - "documentation":"The runId of the workflow execution to cancel.
" - } - } - }, - "RespondActivityTaskCanceledInput":{ - "type":"structure", - "required":["taskToken"], - "members":{ - "taskToken":{ - "shape":"TaskToken", - "documentation":"The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.Optional. Information about the cancellation.
" - } - } - }, - "RespondActivityTaskCompletedInput":{ - "type":"structure", - "required":["taskToken"], - "members":{ - "taskToken":{ - "shape":"TaskToken", - "documentation":"The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The result of the activity task. It is a free form string that is implementation specific.
" - } - } - }, - "RespondActivityTaskFailedInput":{ - "type":"structure", - "required":["taskToken"], - "members":{ - "taskToken":{ - "shape":"TaskToken", - "documentation":"The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.Description of the error that may assist in diagnostics.
" - }, - "details":{ - "shape":"Data", - "documentation":"Optional. Detailed information about the failure.
" - } - } - }, - "RespondDecisionTaskCompletedInput":{ - "type":"structure", - "required":["taskToken"], - "members":{ - "taskToken":{ - "shape":"TaskToken", - "documentation":"The taskToken from the DecisionTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.
" - }, - "executionContext":{ - "shape":"Data", - "documentation":"User defined context to add to workflow execution.
" - } - } - }, - "ReverseOrder":{"type":"boolean"}, - "Run":{ - "type":"structure", - "members":{ - "runId":{ - "shape":"RunId", - "documentation":"The runId of a workflow execution. This Id is generated by the service and can be used to uniquely identify the workflow execution within a domain.
Specifies the runId of a workflow execution.
Required. The type of the activity task to schedule.
" - }, - "activityId":{ - "shape":"ActivityId", - "documentation":"Required. The activityId of the activity task.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
" - }, - "input":{ - "shape":"Data", - "documentation":"The input provided to the activity task.
" - }, - "scheduleToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for this activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "scheduleToStartTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - } - }, - "documentation":"Provides details of the ScheduleActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.taskList: String constraint. The key is swf:taskList.name.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "ScheduleActivityTaskFailedCause":{ - "type":"string", - "enum":[ - "ACTIVITY_TYPE_DEPRECATED", - "ACTIVITY_TYPE_DOES_NOT_EXIST", - "ACTIVITY_ID_ALREADY_IN_USE", - "OPEN_ACTIVITIES_LIMIT_EXCEEDED", - "ACTIVITY_CREATION_RATE_EXCEEDED", - "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", - "DEFAULT_TASK_LIST_UNDEFINED", - "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", - "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", - "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", - "OPERATION_NOT_PERMITTED" - ] - }, - "ScheduleActivityTaskFailedEventAttributes":{ - "type":"structure", - "required":[ - "activityType", - "activityId", - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "activityType":{ - "shape":"ActivityType", - "documentation":"The activity type provided in the ScheduleActivityTask decision that failed.
The activityId provided in the ScheduleActivityTask decision that failed.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the ScheduleActivityTaskFailed event.
Required. The workflowId of the workflow execution to be signaled.
The runId of the workflow execution to be signaled.
Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.
" - }, - "input":{ - "shape":"Data", - "documentation":"Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.
" - }, - "control":{ - "shape":"Data", - "documentation":"Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.
" - } - }, - "documentation":"Provides details of the SignalExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "SignalExternalWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", - "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", - "OPERATION_NOT_PERMITTED" - ] - }, - "SignalExternalWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "workflowId", - "cause", - "initiatedEventId", - "decisionTaskCompletedEventId" - ], - "members":{ - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The workflowId of the external workflow execution that the signal was being delivered to.
The runId of the external workflow execution that the signal was being delivered to.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the SignalExternalWorkflowExecutionFailed event.
The workflowId of the external workflow execution.
The runId of the external workflow execution to send the signal to.
The name of the signal.
" - }, - "input":{ - "shape":"Data", - "documentation":"Input provided to the signal (if any).
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Optional. data attached to the event that can be used by the decider in subsequent decision tasks.
" - } - }, - "documentation":"Provides details of the SignalExternalWorkflowExecutionInitiated event.
The name of the domain containing the workflow execution to signal.
" - }, - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The workflowId of the workflow execution to signal.
" - }, - "runId":{ - "shape":"RunIdOptional", - "documentation":"The runId of the workflow execution to signal.
" - }, - "signalName":{ - "shape":"SignalName", - "documentation":"The name of the signal. This name must be meaningful to the target workflow.
" - }, - "input":{ - "shape":"Data", - "documentation":"Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
Required. The type of the workflow execution to be started.
" - }, - "workflowId":{ - "shape":"WorkflowId", - "documentation":"Required. The workflowId of the workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
" - }, - "input":{ - "shape":"Data", - "documentation":"The input to be provided to the workflow execution.
" - }, - "executionStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
The name of the task list to be used for decision tasks of the child workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "taskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
" - } - }, - "documentation":"Provides details of the StartChildWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagList.member.N: The key is \"swf:tagList.N\" where N is the tag number from 0 to 4, inclusive.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "StartChildWorkflowExecutionFailedCause":{ - "type":"string", - "enum":[ - "WORKFLOW_TYPE_DOES_NOT_EXIST", - "WORKFLOW_TYPE_DEPRECATED", - "OPEN_CHILDREN_LIMIT_EXCEEDED", - "OPEN_WORKFLOWS_LIMIT_EXCEEDED", - "CHILD_CREATION_RATE_EXCEEDED", - "WORKFLOW_ALREADY_RUNNING", - "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", - "DEFAULT_TASK_LIST_UNDEFINED", - "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", - "DEFAULT_CHILD_POLICY_UNDEFINED", - "OPERATION_NOT_PERMITTED" - ] - }, - "StartChildWorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":[ - "workflowType", - "cause", - "workflowId", - "initiatedEventId", - "decisionTaskCompletedEventId" - ], - "members":{ - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The workflow type provided in the StartChildWorkflowExecution Decision that failed.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The workflowId of the child workflow execution.
The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
Provides details of the StartChildWorkflowExecutionFailed event.
The workflowId of the child workflow execution.
The type of the child workflow execution.
" - }, - "control":{ - "shape":"Data", - "documentation":"Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
" - }, - "input":{ - "shape":"Data", - "documentation":"The inputs provided to the child workflow execution (if any).
" - }, - "executionStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"The name of the task list used for the decision tasks of the child workflow execution.
" - }, - "taskPriority":{ - "shape":"TaskPriority", - "documentation":"Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The maximum duration allowed for the decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "tagList":{ - "shape":"TagList", - "documentation":"The list of tags to associated with the child workflow execution.
" - } - }, - "documentation":"Provides details of the StartChildWorkflowExecutionInitiated event.
Required. The unique Id of the timer.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" - }, - "startToFireTimeout":{ - "shape":"DurationInSeconds", - "documentation":"Required. The duration to wait before firing the timer.
The duration is specified in seconds; an integer greater than or equal to 0.
" - } - }, - "documentation":"Provides details of the StartTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" - }, - "StartTimerFailedCause":{ - "type":"string", - "enum":[ - "TIMER_ID_ALREADY_IN_USE", - "OPEN_TIMERS_LIMIT_EXCEEDED", - "TIMER_CREATION_RATE_EXCEEDED", - "OPERATION_NOT_PERMITTED" - ] - }, - "StartTimerFailedEventAttributes":{ - "type":"structure", - "required":[ - "timerId", - "cause", - "decisionTaskCompletedEventId" - ], - "members":{ - "timerId":{ - "shape":"TimerId", - "documentation":"The timerId provided in the StartTimer decision that failed.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the StartTimerFailed event.
The name of the domain in which the workflow execution is created.
" - }, - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The type of the workflow to start.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "input":{ - "shape":"Data", - "documentation":"The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
" - }, - "taskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.
" - } - }, - "documentation":"Used to filter the workflow executions in visibility APIs based on a tag.
" - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":5 - }, - "TaskList":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the task list.
" - } - }, - "documentation":"Represents a task list.
" - }, - "TaskPriority":{ - "type":"string", - "max":11 - }, - "TaskToken":{ - "type":"string", - "min":1, - "max":1024 - }, - "TerminateReason":{ - "type":"string", - "max":256 - }, - "TerminateWorkflowExecutionInput":{ - "type":"structure", - "required":[ - "domain", - "workflowId" - ], - "members":{ - "domain":{ - "shape":"DomainName", - "documentation":"The domain of the workflow execution to terminate.
" - }, - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The workflowId of the workflow execution to terminate.
" - }, - "runId":{ - "shape":"RunIdOptional", - "documentation":"The runId of the workflow execution to terminate.
" - }, - "reason":{ - "shape":"TerminateReason", - "documentation":"Optional. A descriptive reason for terminating the workflow execution.
" - }, - "details":{ - "shape":"Data", - "documentation":"Optional. Details for terminating the workflow execution.
" - }, - "childPolicy":{ - "shape":"ChildPolicy", - "documentation":"If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The unique Id of the timer that was canceled.
" - }, - "startedEventId":{ - "shape":"EventId", - "documentation":"The id of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the TimerCanceled event.
The unique Id of the timer that fired.
" - }, - "startedEventId":{ - "shape":"EventId", - "documentation":"The id of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the TimerFired event.
The unique Id of the timer that was started.
" - }, - "control":{ - "shape":"Data", - "documentation":"Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
" - }, - "startToFireTimeout":{ - "shape":"DurationInSeconds", - "documentation":"The duration of time after which the timer will fire.
The duration is specified in seconds; an integer greater than or equal to 0.
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the TimerStarted event.
A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
" - }, - "TypeDeprecatedFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned when the specified activity or workflow type was already deprecated.
" - }, - "UnknownResourceFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
" - }, - "Version":{ - "type":"string", - "min":1, - "max":64 - }, - "VersionOptional":{ - "type":"string", - "max":64 - }, - "WorkflowExecution":{ - "type":"structure", - "required":[ - "workflowId", - "runId" - ], - "members":{ - "workflowId":{ - "shape":"WorkflowId", - "documentation":"The user defined identifier associated with the workflow execution.
" - }, - "runId":{ - "shape":"RunId", - "documentation":"A system-generated unique identifier for the workflow execution.
" - } - }, - "documentation":"Represents a workflow execution.
" - }, - "WorkflowExecutionAlreadyStartedFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"ErrorMessage", - "documentation":"A description that may help with diagnosing the cause of the fault.
" - } - }, - "exception":true, - "documentation":"Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
" - }, - "WorkflowExecutionCancelRequestedCause":{ - "type":"string", - "enum":["CHILD_POLICY_APPLIED"] - }, - "WorkflowExecutionCancelRequestedEventAttributes":{ - "type":"structure", - "members":{ - "externalWorkflowExecution":{ - "shape":"WorkflowExecution", - "documentation":"The external workflow execution for which the cancellation was requested.
" - }, - "externalInitiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this Id can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.
" - } - }, - "documentation":"Provides details of the WorkflowExecutionCancelRequested event.
Details for the cancellation (if any).
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the WorkflowExecutionCanceled event.
The result produced by the workflow execution upon successful completion.
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the WorkflowExecutionCompleted event.
The maximum duration allowed for decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "executionStartToCloseTimeout":{ - "shape":"DurationInSeconds", - "documentation":"The total duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "taskList":{ - "shape":"TaskList", - "documentation":"The task list used for the decision tasks generated for this workflow execution.
" - }, - "taskPriority":{ - "shape":"TaskPriority", - "documentation":"The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "childPolicy":{ - "shape":"ChildPolicy", - "documentation":"The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.
" - }, - "WorkflowExecutionContinuedAsNewEventAttributes":{ - "type":"structure", - "required":[ - "decisionTaskCompletedEventId", - "newExecutionRunId", - "taskList", - "childPolicy", - "workflowType" - ], - "members":{ - "input":{ - "shape":"Data", - "documentation":"The input provided to the new workflow execution.
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The runId of the new workflow execution.
The total duration allowed for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "taskList":{"shape":"TaskList"}, - "taskPriority":{"shape":"TaskPriority"}, - "taskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration of decision tasks for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "childPolicy":{ - "shape":"ChildPolicy", - "documentation":"The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The list of tags associated with the new workflow execution.
" - }, - "workflowType":{"shape":"WorkflowType"} - }, - "documentation":"Provides details of the WorkflowExecutionContinuedAsNew event.
The number of workflow executions.
" - }, - "truncated":{ - "shape":"Truncated", - "documentation":"If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
" - } - }, - "documentation":"Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
" - }, - "WorkflowExecutionDetail":{ - "type":"structure", - "required":[ - "executionInfo", - "executionConfiguration", - "openCounts" - ], - "members":{ - "executionInfo":{ - "shape":"WorkflowExecutionInfo", - "documentation":"Information about the workflow execution.
" - }, - "executionConfiguration":{ - "shape":"WorkflowExecutionConfiguration", - "documentation":"The configuration settings for this workflow execution including timeout values, tasklist etc.
" - }, - "openCounts":{ - "shape":"WorkflowExecutionOpenCounts", - "documentation":"The number of tasks for this workflow execution. This includes open and closed tasks of all types.
" - }, - "latestActivityTaskTimestamp":{ - "shape":"Timestamp", - "documentation":"The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.
" - }, - "latestExecutionContext":{ - "shape":"Data", - "documentation":"The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.
" - } - }, - "documentation":"Contains details about a workflow execution.
" - }, - "WorkflowExecutionFailedEventAttributes":{ - "type":"structure", - "required":["decisionTaskCompletedEventId"], - "members":{ - "reason":{ - "shape":"FailureReason", - "documentation":"The descriptive reason provided for the failure (if any).
" - }, - "details":{ - "shape":"Data", - "documentation":"The details of the failure (if any).
" - }, - "decisionTaskCompletedEventId":{ - "shape":"EventId", - "documentation":"The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of the WorkflowExecutionFailed event.
The workflowId to pass of match the criteria of this filter.
" - } - }, - "documentation":"Used to filter the workflow executions in visibility APIs by their workflowId.
The workflow execution this information is about.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The type of the workflow execution.
" - }, - "startTimestamp":{ - "shape":"Timestamp", - "documentation":"The time when the execution was started.
" - }, - "closeTimestamp":{ - "shape":"Timestamp", - "documentation":"The time when the workflow execution was closed. Set only if the execution status is CLOSED.
" - }, - "executionStatus":{ - "shape":"ExecutionStatus", - "documentation":"The current status of the execution.
" - }, - "closeStatus":{ - "shape":"CloseStatus", - "documentation":"If the execution status is closed then this specifies how the execution was closed:
COMPLETED: the execution was successfully completed.CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.TERMINATED: the execution was force terminated.FAILED: the execution failed to complete.TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
" - }, - "tagList":{ - "shape":"TagList", - "documentation":"The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
" - }, - "cancelRequested":{ - "shape":"Canceled", - "documentation":"Set to true if a cancellation is requested for this workflow execution.
" - } - }, - "documentation":"Contains information about a workflow execution.
" - }, - "WorkflowExecutionInfoList":{ - "type":"list", - "member":{"shape":"WorkflowExecutionInfo"} - }, - "WorkflowExecutionInfos":{ - "type":"structure", - "required":["executionInfos"], - "members":{ - "executionInfos":{ - "shape":"WorkflowExecutionInfoList", - "documentation":"The list of workflow information structures.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Contains a paginated list of information about workflow executions.
" - }, - "WorkflowExecutionOpenCounts":{ - "type":"structure", - "required":[ - "openActivityTasks", - "openDecisionTasks", - "openTimers", - "openChildWorkflowExecutions" - ], - "members":{ - "openActivityTasks":{ - "shape":"Count", - "documentation":"The count of activity tasks whose status is OPEN.
" - }, - "openDecisionTasks":{ - "shape":"OpenDecisionTasksCount", - "documentation":"The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
" - }, - "openTimers":{ - "shape":"Count", - "documentation":"The count of timers started by this workflow execution that have not fired yet.
" - }, - "openChildWorkflowExecutions":{ - "shape":"Count", - "documentation":"The count of child workflow executions whose status is OPEN.
" - } - }, - "documentation":"Contains the counts of open tasks, child workflow executions and timers for a workflow execution.
" - }, - "WorkflowExecutionSignaledEventAttributes":{ - "type":"structure", - "required":["signalName"], - "members":{ - "signalName":{ - "shape":"SignalName", - "documentation":"The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
" - }, - "input":{ - "shape":"Data", - "documentation":"Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
" - }, - "externalWorkflowExecution":{ - "shape":"WorkflowExecution", - "documentation":"The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
" - }, - "externalInitiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this Id can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.
Provides details of the WorkflowExecutionSignaled event.
The input provided to the workflow execution (if any).
" - }, - "executionStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "taskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "childPolicy":{ - "shape":"ChildPolicy", - "documentation":"The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The name of the task list for scheduling the decision tasks for this workflow execution.
" - }, - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The workflow type of this execution.
" - }, - "tagList":{ - "shape":"TagList", - "documentation":"The list of tags associated with this workflow execution. An execution can have up to 5 tags.
" - }, - "taskPriority":{"shape":"TaskPriority"}, - "continuedExecutionRunId":{ - "shape":"RunIdOptional", - "documentation":"If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
" - }, - "parentInitiatedEventId":{ - "shape":"EventId", - "documentation":"The id of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this Id can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
Provides details of WorkflowExecutionStarted event.
The reason provided for the termination (if any).
" - }, - "details":{ - "shape":"Data", - "documentation":"The details provided for the termination (if any).
" - }, - "childPolicy":{ - "shape":"ChildPolicy", - "documentation":"The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
" - } - }, - "documentation":"Provides details of the WorkflowExecutionTerminated event.
The type of timeout that caused this event.
" - }, - "childPolicy":{ - "shape":"ChildPolicy", - "documentation":"The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.Provides details of the WorkflowExecutionTimedOut event.
Required. The name of the workflow type.
Required. The version of the workflow type.
Represents a workflow type.
" - }, - "WorkflowTypeConfiguration":{ - "type":"structure", - "members":{ - "defaultTaskStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultExecutionStartToCloseTimeout":{ - "shape":"DurationInSecondsOptional", - "documentation":"Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" - }, - "defaultTaskList":{ - "shape":"TaskList", - "documentation":"Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" - }, - "defaultChildPolicy":{ - "shape":"ChildPolicy", - "documentation":"Optional. The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The configuration settings of a workflow type.
" - }, - "WorkflowTypeDetail":{ - "type":"structure", - "required":[ - "typeInfo", - "configuration" - ], - "members":{ - "typeInfo":{ - "shape":"WorkflowTypeInfo", - "documentation":"General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
Configuration settings of the workflow type registered through RegisterWorkflowType
" - } - }, - "documentation":"Contains details about a workflow type.
" - }, - "WorkflowTypeFilter":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"Required. Name of the workflow type.
" - }, - "version":{ - "shape":"VersionOptional", - "documentation":"Version of the workflow type.
" - } - }, - "documentation":"Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.
" - }, - "WorkflowTypeInfo":{ - "type":"structure", - "required":[ - "workflowType", - "status", - "creationDate" - ], - "members":{ - "workflowType":{ - "shape":"WorkflowType", - "documentation":"The workflow type this information is about.
" - }, - "status":{ - "shape":"RegistrationStatus", - "documentation":"The current status of the workflow type.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the type registered through RegisterWorkflowType.
" - }, - "creationDate":{ - "shape":"Timestamp", - "documentation":"The date when this type was registered.
" - }, - "deprecationDate":{ - "shape":"Timestamp", - "documentation":"If the type is in deprecated state, then it is set to the date when the type was deprecated.
" - } - }, - "documentation":"Contains information about a workflow type.
" - }, - "WorkflowTypeInfoList":{ - "type":"list", - "member":{"shape":"WorkflowTypeInfo"} - }, - "WorkflowTypeInfos":{ - "type":"structure", - "required":["typeInfos"], - "members":{ - "typeInfos":{ - "shape":"WorkflowTypeInfoList", - "documentation":"The list of workflow type information.
" - }, - "nextPageToken":{ - "shape":"PageToken", - "documentation":"If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Contains a paginated list of information structures about workflow types.
" - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/apis/swf/2012-01-25.paginators.json b/src/github.com/getlantern/aws-sdk-go/apis/swf/2012-01-25.paginators.json deleted file mode 100644 index e92bfebe6b..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/apis/swf/2012-01-25.paginators.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "pagination": { - "GetWorkflowExecutionHistory": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "events" - }, - "ListActivityTypes": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "typeInfos" - }, - "ListClosedWorkflowExecutions": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "executionInfos" - }, - "ListDomains": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "domainInfos" - }, - "ListOpenWorkflowExecutions": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "executionInfos" - }, - "ListWorkflowTypes": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "typeInfos" - }, - "PollForDecisionTask": { - "limit_key": "maximumPageSize", - "input_token": "nextPageToken", - "output_token": "nextPageToken", - "result_key": "events", - "non_aggregate_keys": [ - "taskToken", - "startedEventId", - "workflowExecution", - "workflowType", - "previousStartedEventId" - ] - } - } -} diff --git a/src/github.com/getlantern/aws-sdk-go/aws/auth.go b/src/github.com/getlantern/aws-sdk-go/aws/auth.go deleted file mode 100644 index a29b0c2b7b..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/aws/auth.go +++ /dev/null @@ -1,270 +0,0 @@ -package aws - -import ( - "bufio" - "encoding/json" - "fmt" - "net/http" - "os" - "os/user" - "path" - "sync" - "time" - - "github.com/vaughan0/go-ini" -) - -// Credentials are used to authenticate and authorize calls that you make to -// AWS. -type Credentials struct { - AccessKeyID string - SecretAccessKey string - SecurityToken string -} - -// A CredentialsProvider is a provider of credentials. -type CredentialsProvider interface { - // Credentials returns a set of credentials (or an error if no credentials - // could be provided). - Credentials() (*Credentials, error) -} - -var ( - // ErrAccessKeyIDNotFound is returned when the AWS Access Key ID can't be - // found in the process's environment. - ErrAccessKeyIDNotFound = fmt.Errorf("AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY not found in environment") - // ErrSecretAccessKeyNotFound is returned when the AWS Secret Access Key - // can't be found in the process's environment. - ErrSecretAccessKeyNotFound = fmt.Errorf("AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY not found in environment") -) - -// Context encapsulates the context of a client's connection to an AWS service. -type Context struct { - Service string - Region string - Credentials CredentialsProvider -} - -var currentTime = func() time.Time { - return time.Now() -} - -// DetectCreds returns a CredentialsProvider based on the available information. -// -// If the access key ID and secret access key are provided, it returns a basic -// provider. -// -// If credentials are available via environment variables, it returns an -// environment provider. -// -// If a profile configuration file is available in the default location and has -// a default profile configured, it returns a profile provider. -// -// Otherwise, it returns an IAM instance provider. -func DetectCreds(accessKeyID, secretAccessKey, securityToken string) CredentialsProvider { - if accessKeyID != "" && secretAccessKey != "" { - return Creds(accessKeyID, secretAccessKey, securityToken) - } - - env, err := EnvCreds() - if err == nil { - return env - } - - profile, err := ProfileCreds("", "", 10*time.Minute) - if err != nil { - return IAMCreds() - } - - _, err = profile.Credentials() - if err != nil { - return IAMCreds() - } - - return profile -} - -// EnvCreds returns a static provider of AWS credentials from the process's -// environment, or an error if none are found. -func EnvCreds() (CredentialsProvider, error) { - id := os.Getenv("AWS_ACCESS_KEY_ID") - if id == "" { - id = os.Getenv("AWS_ACCESS_KEY") - } - - secret := os.Getenv("AWS_SECRET_ACCESS_KEY") - if secret == "" { - secret = os.Getenv("AWS_SECRET_KEY") - } - - if id == "" { - return nil, ErrAccessKeyIDNotFound - } - - if secret == "" { - return nil, ErrSecretAccessKeyNotFound - } - - return Creds(id, secret, os.Getenv("AWS_SESSION_TOKEN")), nil -} - -// Creds returns a static provider of credentials. -func Creds(accessKeyID, secretAccessKey, securityToken string) CredentialsProvider { - return staticCredentialsProvider{ - creds: Credentials{ - AccessKeyID: accessKeyID, - SecretAccessKey: secretAccessKey, - SecurityToken: securityToken, - }, - } -} - -// IAMCreds returns a provider which pulls credentials from the local EC2 -// instance's IAM roles. -func IAMCreds() CredentialsProvider { - return &iamProvider{} -} - -// ProfileCreds returns a provider which pulls credentials from the profile -// configuration file. -func ProfileCreds(filename, profile string, expiry time.Duration) (CredentialsProvider, error) { - if filename == "" { - u, err := user.Current() - if err != nil { - return nil, err - } - - filename = path.Join(u.HomeDir, ".aws", "credentials") - } - - if profile == "" { - profile = "default" - } - - return &profileProvider{ - filename: filename, - profile: profile, - expiry: expiry, - }, nil -} - -type profileProvider struct { - filename string - profile string - expiry time.Duration - - creds Credentials - m sync.Mutex - expiration time.Time -} - -func (p *profileProvider) Credentials() (*Credentials, error) { - p.m.Lock() - defer p.m.Unlock() - - if p.expiration.After(currentTime()) { - return &p.creds, nil - } - - config, err := ini.LoadFile(p.filename) - if err != nil { - return nil, err - } - profile := config.Section(p.profile) - - accessKeyID, ok := profile["aws_access_key_id"] - if !ok { - return nil, fmt.Errorf("profile %s in %s did not contain aws_access_key_id", p.profile, p.filename) - } - - secretAccessKey, ok := profile["aws_secret_access_key"] - if !ok { - return nil, fmt.Errorf("profile %s in %s did not contain aws_secret_access_key", p.profile, p.filename) - } - - securityToken := profile["aws_session_token"] - - p.creds = Credentials{ - AccessKeyID: accessKeyID, - SecretAccessKey: secretAccessKey, - SecurityToken: securityToken, - } - p.expiration = currentTime().Add(p.expiry) - - return &p.creds, nil -} - -type iamProvider struct { - creds Credentials - m sync.Mutex - expiration time.Time -} - -var metadataCredentialsEndpoint = "http://169.254.169.254/latest/meta-data/iam/security-credentials/" - -// IAMClient is the HTTP client used to query the metadata endpoint for IAM -// credentials. -var IAMClient = http.Client{ - Timeout: 1 * time.Second, -} - -func (p *iamProvider) Credentials() (*Credentials, error) { - p.m.Lock() - defer p.m.Unlock() - - if p.expiration.After(currentTime()) { - return &p.creds, nil - } - - var body struct { - Expiration time.Time - AccessKeyID string - SecretAccessKey string - Token string - } - - resp, err := IAMClient.Get(metadataCredentialsEndpoint) - if err != nil { - return nil, fmt.Errorf("listing IAM credentials") - } - defer func() { - _ = resp.Body.Close() - }() - - // Take the first line of the body of the metadata endpoint - s := bufio.NewScanner(resp.Body) - if !s.Scan() { - return nil, fmt.Errorf("unable to find default IAM credentials") - } else if s.Err() != nil { - return nil, fmt.Errorf("%s listing IAM credentials", s.Err()) - } - - resp, err = IAMClient.Get(metadataCredentialsEndpoint + s.Text()) - if err != nil { - return nil, fmt.Errorf("getting %s IAM credentials", s.Text()) - } - defer func() { - _ = resp.Body.Close() - }() - - if err := json.NewDecoder(resp.Body).Decode(&body); err != nil { - return nil, fmt.Errorf("decoding %s IAM credentials", s.Text()) - } - - p.creds = Credentials{ - AccessKeyID: body.AccessKeyID, - SecretAccessKey: body.SecretAccessKey, - SecurityToken: body.Token, - } - p.expiration = body.Expiration - - return &p.creds, nil -} - -type staticCredentialsProvider struct { - creds Credentials -} - -func (p staticCredentialsProvider) Credentials() (*Credentials, error) { - return &p.creds, nil -} diff --git a/src/github.com/getlantern/aws-sdk-go/aws/auth_test.go b/src/github.com/getlantern/aws-sdk-go/aws/auth_test.go deleted file mode 100644 index 339789809d..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/aws/auth_test.go +++ /dev/null @@ -1,236 +0,0 @@ -package aws - -import ( - "fmt" - "net/http" - "net/http/httptest" - "os" - "testing" - "time" -) - -func TestEnvCreds(t *testing.T) { - os.Clearenv() - os.Setenv("AWS_ACCESS_KEY_ID", "access") - os.Setenv("AWS_SECRET_ACCESS_KEY", "secret") - os.Setenv("AWS_SESSION_TOKEN", "token") - - prov, err := EnvCreds() - if err != nil { - t.Fatal(err) - } - - creds, err := prov.Credentials() - if err != nil { - t.Fatal(err) - } - - if v, want := creds.AccessKeyID, "access"; v != want { - t.Errorf("Access key ID was %v, expected %v", v, want) - } - - if v, want := creds.SecretAccessKey, "secret"; v != want { - t.Errorf("Secret access key was %v, expected %v", v, want) - } - - if v, want := creds.SecurityToken, "token"; v != want { - t.Errorf("Security token was %v, expected %v", v, want) - } -} - -func TestEnvCredsNoAccessKeyID(t *testing.T) { - os.Clearenv() - os.Setenv("AWS_SECRET_ACCESS_KEY", "secret") - - prov, err := EnvCreds() - if err != ErrAccessKeyIDNotFound { - t.Fatalf("ErrAccessKeyIDNotFound expected, but was %#v/%#v", prov, err) - } -} - -func TestEnvCredsNoSecretAccessKey(t *testing.T) { - os.Clearenv() - os.Setenv("AWS_ACCESS_KEY_ID", "access") - - prov, err := EnvCreds() - if err != ErrSecretAccessKeyNotFound { - t.Fatalf("ErrSecretAccessKeyNotFound expected, but was %#v/%#v", prov, err) - } -} - -func TestEnvCredsAlternateNames(t *testing.T) { - os.Clearenv() - os.Setenv("AWS_ACCESS_KEY", "access") - os.Setenv("AWS_SECRET_KEY", "secret") - - prov, err := EnvCreds() - if err != nil { - t.Fatal(err) - } - - creds, err := prov.Credentials() - if err != nil { - t.Fatal(err) - } - - if v, want := creds.AccessKeyID, "access"; v != want { - t.Errorf("Access key ID was %v, expected %v", v, want) - } - - if v, want := creds.SecretAccessKey, "secret"; v != want { - t.Errorf("Secret access key was %v, expected %v", v, want) - } -} - -func TestIAMCreds(t *testing.T) { - server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if r.RequestURI == "/" { - fmt.Fprintln(w, "/creds") - } else { - fmt.Fprintln(w, `{ - "AccessKeyId" : "accessKey", - "SecretAccessKey" : "secret", - "Token" : "token", - "Expiration" : "2014-12-16T01:51:37Z" -}`) - } - })) - defer server.Close() - - defer func(s string) { - metadataCredentialsEndpoint = s - }(metadataCredentialsEndpoint) - metadataCredentialsEndpoint = server.URL - - defer func() { - currentTime = time.Now - }() - currentTime = func() time.Time { - return time.Date(2014, 12, 15, 21, 26, 0, 0, time.UTC) - } - - prov := IAMCreds() - creds, err := prov.Credentials() - if err != nil { - t.Fatal(err) - } - - if v, want := creds.AccessKeyID, "accessKey"; v != want { - t.Errorf("AcccessKeyID was %v, but expected %v", v, want) - } - - if v, want := creds.SecretAccessKey, "secret"; v != want { - t.Errorf("SecretAccessKey was %v, but expected %v", v, want) - } - - if v, want := creds.SecurityToken, "token"; v != want { - t.Errorf("SecurityToken was %v, but expected %v", v, want) - } -} - -func TestProfileCreds(t *testing.T) { - prov, err := ProfileCreds("example.ini", "", 10*time.Minute) - if err != nil { - t.Fatal(err) - } - - creds, err := prov.Credentials() - if err != nil { - t.Fatal(err) - } - - if v, want := creds.AccessKeyID, "accessKey"; v != want { - t.Errorf("AcccessKeyID was %v, but expected %v", v, want) - } - - if v, want := creds.SecretAccessKey, "secret"; v != want { - t.Errorf("SecretAccessKey was %v, but expected %v", v, want) - } - - if v, want := creds.SecurityToken, "token"; v != want { - t.Errorf("SecurityToken was %v, but expected %v", v, want) - } -} - -func TestProfileCredsWithoutToken(t *testing.T) { - prov, err := ProfileCreds("example.ini", "no_token", 10*time.Minute) - if err != nil { - t.Fatal(err) - } - - creds, err := prov.Credentials() - if err != nil { - t.Fatal(err) - } - - if v, want := creds.AccessKeyID, "accessKey"; v != want { - t.Errorf("AcccessKeyID was %v, but expected %v", v, want) - } - - if v, want := creds.SecretAccessKey, "secret"; v != want { - t.Errorf("SecretAccessKey was %v, but expected %v", v, want) - } - - if v, want := creds.SecurityToken, ""; v != want { - t.Errorf("SecurityToken was %v, but expected %v", v, want) - } -} - -func BenchmarkProfileCreds(b *testing.B) { - prov, err := ProfileCreds("example.ini", "", 10*time.Minute) - if err != nil { - b.Fatal(err) - } - - b.ResetTimer() - - b.RunParallel(func(pb *testing.PB) { - for pb.Next() { - _, err := prov.Credentials() - if err != nil { - b.Fatal(err) - } - } - }) -} - -func BenchmarkIAMCreds(b *testing.B) { - server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if r.RequestURI == "/" { - fmt.Fprintln(w, "/creds") - } else { - fmt.Fprintln(w, `{ - "AccessKeyId" : "accessKey", - "SecretAccessKey" : "secret", - "Token" : "token", - "Expiration" : "2014-12-16T01:51:37Z" -}`) - } - })) - defer server.Close() - - defer func(s string) { - metadataCredentialsEndpoint = s - }(metadataCredentialsEndpoint) - metadataCredentialsEndpoint = server.URL - - defer func() { - currentTime = time.Now - }() - currentTime = func() time.Time { - return time.Date(2014, 12, 15, 21, 26, 0, 0, time.UTC) - } - - b.ResetTimer() - - prov := IAMCreds() - - b.RunParallel(func(pb *testing.PB) { - for pb.Next() { - _, err := prov.Credentials() - if err != nil { - b.Fatal(err) - } - } - }) -} diff --git a/src/github.com/getlantern/aws-sdk-go/aws/doc.go b/src/github.com/getlantern/aws-sdk-go/aws/doc.go deleted file mode 100644 index 465e362981..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/aws/doc.go +++ /dev/null @@ -1,3 +0,0 @@ -// Package aws contains support code for the various AWS clients in the -// github.com/awslabs/aws-sdk-go/gen subpackages. -package aws diff --git a/src/github.com/getlantern/aws-sdk-go/aws/ec2.go b/src/github.com/getlantern/aws-sdk-go/aws/ec2.go deleted file mode 100644 index 7cef773ab6..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/aws/ec2.go +++ /dev/null @@ -1,176 +0,0 @@ -package aws - -import ( - "encoding/xml" - "fmt" - "io/ioutil" - "net/http" - "net/url" - "reflect" - "strconv" - "strings" - "time" -) - -// EC2Client is the underlying client for EC2 APIs. -type EC2Client struct { - Context Context - Client *http.Client - Endpoint string - APIVersion string -} - -// Do sends an HTTP request and returns an HTTP response, following policy -// (e.g. redirects, cookies, auth) as configured on the client. -func (c *EC2Client) Do(op, method, uri string, req, resp interface{}) error { - body := url.Values{"Action": {op}, "Version": {c.APIVersion}} - if err := c.loadValues(body, req, ""); err != nil { - return err - } - - httpReq, err := http.NewRequest(method, c.Endpoint+uri, strings.NewReader(body.Encode())) - if err != nil { - return err - } - httpReq.Header.Set("Content-Type", "application/x-www-form-urlencoded") - httpReq.Header.Set("User-Agent", "aws-go") - if err := c.Context.sign(httpReq); err != nil { - return err - } - - httpResp, err := c.Client.Do(httpReq) - if err != nil { - return err - } - defer func() { - _ = httpResp.Body.Close() - }() - - if httpResp.StatusCode != http.StatusOK { - bodyBytes, err := ioutil.ReadAll(httpResp.Body) - if err != nil { - return err - } - if len(bodyBytes) == 0 { - return APIError{ - StatusCode: httpResp.StatusCode, - Message: httpResp.Status, - } - } - var ec2Err ec2ErrorResponse - if err := xml.Unmarshal(bodyBytes, &ec2Err); err != nil { - return err - } - return ec2Err.Err(httpResp.StatusCode) - } - - if resp != nil { - return xml.NewDecoder(httpResp.Body).Decode(resp) - } - return nil -} - -type ec2ErrorResponse struct { - XMLName xml.Name `xml:"Response"` - Type string `xml:"Errors>Error>Type"` - Code string `xml:"Errors>Error>Code"` - Message string `xml:"Errors>Error>Message"` - RequestID string `xml:"RequestID"` -} - -func (e ec2ErrorResponse) Err(StatusCode int) error { - return APIError{ - StatusCode: StatusCode, - Type: e.Type, - Code: e.Code, - Message: e.Message, - RequestID: e.RequestID, - } -} - -func (c *EC2Client) loadValues(v url.Values, i interface{}, prefix string) error { - value := reflect.ValueOf(i) - - // follow any pointers - for value.Kind() == reflect.Ptr { - value = value.Elem() - } - - if value.Kind() == reflect.Slice { - for i := 0; i < value.Len(); i++ { - vPrefix := prefix - if vPrefix == "" { - vPrefix = strconv.Itoa(i + 1) - } else { - vPrefix = vPrefix + "." + strconv.Itoa(i+1) - } - if err := c.loadValues(v, value.Index(i).Interface(), vPrefix); err != nil { - return err - } - } - return nil - } - - return c.loadStruct(v, value, prefix) -} - -func (c *EC2Client) loadStruct(v url.Values, value reflect.Value, prefix string) error { - if !value.IsValid() { - return nil - } - - t := value.Type() - for i := 0; i < value.NumField(); i++ { - value := value.Field(i) - name := t.Field(i).Tag.Get("ec2") - - if name == "" { - name = t.Field(i).Name - } - if prefix != "" { - name = prefix + "." + name - } - switch casted := value.Interface().(type) { - case StringValue: - if casted != nil { - v.Set(name, *casted) - } - case BooleanValue: - if casted != nil { - v.Set(name, strconv.FormatBool(*casted)) - } - case LongValue: - if casted != nil { - v.Set(name, strconv.FormatInt(*casted, 10)) - } - case IntegerValue: - if casted != nil { - v.Set(name, strconv.Itoa(*casted)) - } - case DoubleValue: - if casted != nil { - v.Set(name, strconv.FormatFloat(*casted, 'f', -1, 64)) - } - case FloatValue: - if casted != nil { - v.Set(name, strconv.FormatFloat(float64(*casted), 'f', -1, 32)) - } - case []string: - if len(casted) != 0 { - for i, val := range casted { - v.Set(fmt.Sprintf("%s.%d", name, i+1), val) - } - } - case time.Time: - if !casted.IsZero() { - const ISO8601UTC = "2006-01-02T15:04:05Z" - v.Set(name, casted.UTC().Format(ISO8601UTC)) - } - default: - if err := c.loadValues(v, value.Interface(), name); err != nil { - return err - } - } - } - return nil -} diff --git a/src/github.com/getlantern/aws-sdk-go/aws/ec2_test.go b/src/github.com/getlantern/aws-sdk-go/aws/ec2_test.go deleted file mode 100644 index 66b4346958..0000000000 --- a/src/github.com/getlantern/aws-sdk-go/aws/ec2_test.go +++ /dev/null @@ -1,227 +0,0 @@ -package aws_test - -import ( - "fmt" - "net/http" - "net/http/httptest" - "net/url" - "reflect" - "sync" - "testing" - "time" - - "github.com/awslabs/aws-sdk-go/aws" -) - -func TestEC2Request(t *testing.T) { - var m sync.Mutex - var httpReq *http.Request - var form url.Values - - server := httptest.NewServer(http.HandlerFunc( - func(w http.ResponseWriter, r *http.Request) { - m.Lock() - defer m.Unlock() - - httpReq = r - - if err := r.ParseForm(); err != nil { - t.Fatal(err) - } - form = r.Form - - fmt.Fprintln(w, `Uh Oh
-Uh Oh
-bonus
-