The output for the DescribeScalingActivities action.
- Required parameters: [Activities] - */ -@interface AWSAutoScalingActivitiesType : AWSModel - - -/** -A list of the requested scaling activities.
- */ -@property (nonatomic, strong) NSArray *activities; - -/** -Acts as a paging mechanism for large result sets. Set to a non-empty string if there are additional results waiting to be returned. Pass this in to subsequent calls to return additional results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -A scaling Activity is a long-running process that represents a change to your AutoScalingGroup, such as changing the size of the group. It can also be a process to replace an instance, or a process to perform any other long-running operations supported by the API.
- Required parameters: [ActivityId, AutoScalingGroupName, Cause, StartTime, StatusCode] - */ -@interface AWSAutoScalingActivity : AWSModel - - -/** -Specifies the ID of the activity.
- */ -@property (nonatomic, strong) NSString *activityId; - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -Contains the reason the activity was begun.
- */ -@property (nonatomic, strong) NSString *cause; - -/** -Contains a friendly, more verbose description of the scaling activity.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -Contains details of the scaling activity.
- */ -@property (nonatomic, strong) NSString *details; - -/** -Provides the end time of this activity.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -Specifies a value between 0 and 100 that indicates the progress of the activity.
- */ -@property (nonatomic, strong) NSNumber *progress; - -/** -Provides the start time of this activity.
- */ -@property (nonatomic, strong) NSDate *startTime; - -/** -Contains the current status of the activity.
- */ -@property (nonatomic, assign) AWSAutoScalingScalingActivityStatusCode statusCode; - -/** -Contains a friendly, more verbose description of the activity status.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -@end - -/** -The output for the TerminateInstanceInAutoScalingGroup action.
- */ -@interface AWSAutoScalingActivityType : AWSModel - - -/** -A scaling Activity.
- */ -@property (nonatomic, strong) AWSAutoScalingActivity *activity; - -@end - -/** - Specifies whether the PutScalingPolicyScalingAdjustment parameter is an absolute number or a percentage of the current capacity.
A policy adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
The Alarm data type.
- */ -@interface AWSAutoScalingAlarm : AWSModel - - -/** -The Amazon Resource Name (ARN) of the alarm.
- */ -@property (nonatomic, strong) NSString *alarmARN; - -/** -The name of the alarm.
- */ -@property (nonatomic, strong) NSString *alarmName; - -@end - -/** - - */ -@interface AWSAutoScalingAttachInstancesQuery : AWSRequest - - -/** -The name of the Auto Scaling group to which to attach the specified instance(s).
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -One or more IDs of the Amazon EC2 instances to attach to the specified Auto Scaling group. You must specify at least one instance ID.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** -The AutoScalingGroup data type.
- Required parameters: [AutoScalingGroupName, LaunchConfigurationName, MinSize, MaxSize, DesiredCapacity, DefaultCooldown, AvailabilityZones, HealthCheckType, CreatedTime] - */ -@interface AWSAutoScalingAutoScalingGroup : AWSModel - - -/** -The Amazon Resource Name (ARN) of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupARN; - -/** -Specifies the name of the group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -Contains a list of Availability Zones for the group.
- */ -@property (nonatomic, strong) NSArray *availabilityZones; - -/** -Specifies the date and time the Auto Scaling group was created.
- */ -@property (nonatomic, strong) NSDate *createdTime; - -/** -The number of seconds after a scaling activity completes before any further scaling activities can start.
- */ -@property (nonatomic, strong) NSNumber *defaultCooldown; - -/** -Specifies the desired capacity for the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *desiredCapacity; - -/** -A list of metrics enabled for this Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *enabledMetrics; - -/** -The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.
- */ -@property (nonatomic, strong) NSNumber *healthCheckGracePeriod; - -/** -The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing.
- */ -@property (nonatomic, strong) NSString *healthCheckType; - -/** -Provides a summary list of Amazon EC2 instances.
- */ -@property (nonatomic, strong) NSArray *instances; - -/** -Specifies the name of the associated LaunchConfiguration.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -A list of load balancers associated with this Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *loadBalancerNames; - -/** -Contains the maximum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *maxSize; - -/** -Contains the minimum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *minSize; - -/** -The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.
- */ -@property (nonatomic, strong) NSString *placementGroup; - -/** -The current state of the Auto Scaling group when a DeleteAutoScalingGroup action is in progress.
- */ -@property (nonatomic, strong) NSString *status; - -/** -Suspended processes associated with this Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *suspendedProcesses; - -/** -A list of tags for the Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -A standalone termination policy or a list of termination policies for this Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *terminationPolicies; - -/** -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.
The AutoScalingGroupNamesType data type.
A list of Auto Scaling group names.
- */ -@property (nonatomic, strong) NSArray *autoScalingGroupNames; - -/** -The maximum number of records to return.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - The AutoScalingGroupsType data type.
A list of Auto Scaling groups.
- */ -@property (nonatomic, strong) NSArray *autoScalingGroups; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - The AutoScalingInstanceDetails data type.
The name of the Auto Scaling group associated with this instance.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The Availability Zone in which this instance resides.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy. Auto Scaling should terminate and replace it.
- */ -@property (nonatomic, strong) NSString *healthStatus; - -/** -The instance ID of the Amazon EC2 instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The launch configuration associated with this instance.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -The life cycle state of this instance. for more information, see Instance Lifecycle State in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSString *lifecycleState; - -@end - -/** - The AutoScalingInstancesType data type.
A list of Auto Scaling instances.
- */ -@property (nonatomic, strong) NSArray *autoScalingInstances; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - The BlockDeviceMapping data type.
The name of the device within Amazon EC2 (for example, /dev/sdh or xvdh).
- */ -@property (nonatomic, strong) NSString *deviceName; - -/** -The Elastic Block Storage volume information.
- */ -@property (nonatomic, strong) AWSAutoScalingEbs *ebs; - -/** -Suppresses the 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.The virtual name associated with the device.
- */ -@property (nonatomic, strong) NSString *virtualName; - -@end - -/** -The output of the CompleteLifecycleAction.
- */ -@interface AWSAutoScalingCompleteLifecycleActionAnswer : AWSModel - - -@end - -/** - - */ -@interface AWSAutoScalingCompleteLifecycleActionType : AWSRequest - - -/** -The name of the Auto Scaling group to which the lifecycle hook belongs.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The action the Auto Scaling group should take. The value for this parameter can be either CONTINUE or ABANDON.
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.
- */ -@property (nonatomic, strong) NSString *lifecycleActionToken; - -/** -The name of the lifecycle hook.
- */ -@property (nonatomic, strong) NSString *lifecycleHookName; - -@end - -/** - - Required parameters: [AutoScalingGroupName, MinSize, MaxSize] - */ -@interface AWSAutoScalingCreateAutoScalingGroupType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -A list of Availability Zones for the Auto Scaling group. This is required unless you have specified subnets.
- */ -@property (nonatomic, strong) NSArray *availabilityZones; - -/** -The amount of time, in seconds, between a successful scaling activity and the succeeding scaling activity.
If a DefaultCooldown period is not specified, Auto Scaling uses the default value of 300 as the default cool down period for the Auto Scaling group. For more information, see Cooldown Period
The number of Amazon EC2 instances that should be running in the group. The desired capacity must be greater than or equal to the minimum size and less than or equal to the maximum size specified for the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *desiredCapacity; - -/** -Length of time in seconds after a new Amazon EC2 instance comes into service that Auto Scaling starts checking its health. During this time any health check failure for the that instance is ignored.
This is required if you are adding ELB health check. Frequently, new instances need to warm up, briefly, before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to match the expected startup period of your application.
For more information, see Add an Elastic Load Balancing Health Check.
- */ -@property (nonatomic, strong) NSNumber *healthCheckGracePeriod; - -/** -The service you want the health checks from, Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
- */ -@property (nonatomic, strong) NSString *healthCheckType; - -/** -The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this attribute if you want to create an Auto Scaling group using an EC2 instance instead of a launch configuration.
When you use an instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its attributes from the instance that is used to create the Auto Scaling group, with the exception of BlockDeviceMapping.
For more information, see Create an Auto Scaling Group Using EC2 Instance in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The name of an existing launch configuration to use to launch new instances. Use this attribute if you want to create an Auto Scaling group using an existing launch configuration instead of an EC2 instance.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -A list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account.
For information on using load balancers, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSArray *loadBalancerNames; - -/** -The maximum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *maxSize; - -/** -The minimum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *minSize; - -/** -Physical location of an existing cluster placement group into which you want to launch your instances. For information about cluster placement group, see Using Cluster Instances
- */ -@property (nonatomic, strong) NSString *placementGroup; - -/** -The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSArray *terminationPolicies; - -/** -A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide .
- */ -@property (nonatomic, strong) NSString *VPCZoneIdentifier; - -@end - -/** - - Required parameters: [LaunchConfigurationName] - */ -@interface AWSAutoScalingCreateLaunchConfigurationType : AWSRequest - - -/** -Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. For more information, see Auto Scaling in Amazon Virtual Private Cloud.
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
Default: If the instance is launched into a default subnet in a default VPC, the default is true. If the instance is launched into a nondefault subnet in a VPC, the default is false. For information about default VPC and VPC platforms, see Supported Platforms.
A list of mappings that specify how block devices are exposed to the instance. Each mapping is made up of a VirtualName, a DeviceName, and an ebs data structure that contains information about the associated Elastic Block Storage volume. For more information about Amazon EC2 BlockDeviceMappings, go to Block Device Mapping in the Amazon EC2 product documentation.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -Whether the instance is optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization is not available with all instance types. Additional usage charges apply when using an EBS Optimized instance. By default the instance is not optimized for EBS I/O. For information about EBS-optimized instances, go to EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.
- */ -@property (nonatomic, strong) NSNumber *ebsOptimized; - -/** -The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSString *iamInstanceProfile; - -/** -Unique ID of the Amazon Machine Image (AMI) you want to use to launch your EC2 instances. For information about finding Amazon EC2 AMIs, see Finding a Suitable AMI in the Amazon Elastic Compute Cloud User Guide.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this attribute if you want the launch configuration to derive its attributes from an EC2 instance.
When you use an instance to create a launch configuration, all you need to specify is the InstanceId. The new launch configuration, by default, derives all the attributes from the specified instance with the exception of BlockDeviceMapping.
If you want to create a launch configuration with BlockDeviceMapping or override any other instance attributes, specify them as part of the same request.
For more information on using an InstanceID to create a launch configuration, see Create a Launch Configuration Using an Amazon EC2 Instance in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.
When detailed monitoring is enabled, Amazon Cloudwatch will generate metrics every minute and your account will be charged a fee. When you disable detailed monitoring, by specifying False, Cloudwatch will generate metrics every 5 minutes. For more information, see Monitor Your Auto Scaling Instances. For information about Amazon CloudWatch, see the Amazon CloudWatch Developer Guide.
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.
- */ -@property (nonatomic, strong) NSString *instanceType; - -/** -The ID of the kernel associated with the Amazon EC2 AMI.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -The name of the Amazon EC2 key pair. For more information, see Getting a Key Pair in the Amazon Elastic Compute Cloud User Guide.
- */ -@property (nonatomic, strong) NSString *keyName; - -/** -The name of the launch configuration to create.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched in a VPC.
You must set the value of this parameter to dedicated if want to launch Dedicated Instances in a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Valid values: default | dedicated
The ID of the RAM disk associated with the Amazon EC2 AMI.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** -The security groups with which to associate Amazon EC2 or Amazon VPC instances.
If your instances are launched in EC2, you can either specify Amazon EC2 security group names or the security group IDs. For more information about Amazon EC2 security groups, see Using Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched within VPC, specify Amazon VPC security group IDs. For more information about Amazon VPC security groups, see Security Groups in the Amazon Virtual Private Cloud User Guide.
- */ -@property (nonatomic, strong) NSArray *securityGroups; - -/** -The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information on launching Spot Instances, see Using Auto Scaling to Launch Spot Instances in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSString *spotPrice; - -/** -The user data to make available to the launched Amazon EC2 instances. For more information about Amazon EC2 user data, see User Data Retrieval in the Amazon Elastic Compute Cloud User Guide.
The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. The resource type and resource ID identify the type and name of resource for which the tag is created. Currently, auto-scaling-group is the only supported resource type. The valid value for the resource ID is groupname.
The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by the Auto Scaling group. Valid values are true or false. However, instances that are already running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be applied only to new instances launched by the Auto Scaling group after the change. Running instances that had the previous version of the tag will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
- */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** - - Required parameters: [AutoScalingGroupName] - */ -@interface AWSAutoScalingDeleteAutoScalingGroupType : AWSRequest - - -/** -The name of the Auto Scaling group to delete.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
- */ -@property (nonatomic, strong) NSNumber *forceDelete; - -@end - -/** -The output of the DeleteLifecycleHook action.
- */ -@interface AWSAutoScalingDeleteLifecycleHookAnswer : AWSModel - - -@end - -/** - - */ -@interface AWSAutoScalingDeleteLifecycleHookType : AWSRequest - - -/** -The name of the Auto Scaling group to which the lifecycle hook belongs.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The name of the lifecycle hook.
- */ -@property (nonatomic, strong) NSString *lifecycleHookName; - -@end - -/** - - Required parameters: [AutoScalingGroupName, TopicARN] - */ -@interface AWSAutoScalingDeleteNotificationConfigurationType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
- */ -@property (nonatomic, strong) NSString *topicARN; - -@end - -/** - - Required parameters: [PolicyName] - */ -@interface AWSAutoScalingDeletePolicyType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The name or PolicyARN of the policy you want to delete.
- */ -@property (nonatomic, strong) NSString *policyName; - -@end - -/** - - Required parameters: [ScheduledActionName] - */ -@interface AWSAutoScalingDeleteScheduledActionType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The name of the action you want to delete.
- */ -@property (nonatomic, strong) NSString *scheduledActionName; - -@end - -/** - - Required parameters: [Tags] - */ -@interface AWSAutoScalingDeleteTagsType : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** -The output of the DescribeAccountLimitsResult action.
- */ -@interface AWSAutoScalingDescribeAccountLimitsAnswer : AWSModel - - -/** -The maximum number of Auto Scaling groups allowed for your AWS account.
- */ -@property (nonatomic, strong) NSNumber *maxNumberOfAutoScalingGroups; - -/** -The maximum number of launch configurations allowed for your AWS account.
- */ -@property (nonatomic, strong) NSNumber *maxNumberOfLaunchConfigurations; - -@end - -/** -The output of the DescribeAdjustmentTypes action.
- */ -@interface AWSAutoScalingDescribeAdjustmentTypesAnswer : AWSModel - - -/** -A list of specific policy adjustment types.
- */ -@property (nonatomic, strong) NSArray *adjustmentTypes; - -@end - -/** - - */ -@interface AWSAutoScalingDescribeAutoScalingInstancesType : AWSRequest - - -/** -The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -/** -The maximum number of Auto Scaling instances to be described with each call.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -The token returned by a previous call to indicate that there is more data available.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -The AutoScalingNotificationTypes data type.
Returns a list of all notification types supported by Auto Scaling. They are:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
Returns a list of all notification types supported by Auto Scaling. They are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
The output of the DescribeLifecycleHooks action.
- */ -@interface AWSAutoScalingDescribeLifecycleHooksAnswer : AWSModel - - -/** -A list describing the lifecycle hooks that belong to the specified Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *lifecycleHooks; - -@end - -/** - - */ -@interface AWSAutoScalingDescribeLifecycleHooksType : AWSRequest - - -/** -The name of one or more Auto Scaling groups.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The name of one or more lifecycle hooks.
- */ -@property (nonatomic, strong) NSArray *lifecycleHookNames; - -@end - -/** -The output of the DescribeMetricCollectionTypes action.
- */ -@interface AWSAutoScalingDescribeMetricCollectionTypesAnswer : AWSModel - - -/** -A list of granularities for the listed Metrics.
- */ -@property (nonatomic, strong) NSArray *granularities; - -/** -The list of Metrics collected. The following metrics are supported:
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 output of the DescribeNotificationConfigurations action.
- Required parameters: [NotificationConfigurations] - */ -@interface AWSAutoScalingDescribeNotificationConfigurationsAnswer : AWSModel - - -/** -A string that is used to mark the start of the next batch of returned results for pagination.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -The list of notification configurations.
- */ -@property (nonatomic, strong) NSArray *notificationConfigurations; - -@end - -/** - - */ -@interface AWSAutoScalingDescribeNotificationConfigurationsType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *autoScalingGroupNames; - -/** -Maximum number of records to be returned.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that is used to mark the start of the next batch of returned results for pagination.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSAutoScalingDescribePoliciesType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The maximum number of policies that will be described with each call.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that is used to mark the start of the next batch of returned results for pagination.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group name is provided, the results are limited to that group. The list of requested policy names cannot contain more than 50 items. If unknown policy names are requested, they are ignored with no error.
- */ -@property (nonatomic, strong) NSArray *policyNames; - -@end - -/** - - */ -@interface AWSAutoScalingDescribeScalingActivitiesType : AWSRequest - - -/** - 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 AutoScalingGroup.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The maximum number of scaling activities to return.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that marks the start of the next batch of returned results for pagination.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSAutoScalingDescribeScheduledActionsType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -The maximum number of scheduled actions to return.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.
- */ -@property (nonatomic, strong) NSArray *scheduledActionNames; - -/** -The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.
- */ -@property (nonatomic, strong) NSDate *startTime; - -@end - -/** - - */ -@interface AWSAutoScalingDescribeTagsType : AWSRequest - - -/** -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).
- */ -@property (nonatomic, strong) NSArray *filters; - -/** -The maximum number of records to return.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -The TerminationPolicyTypes data type.
Termination policies supported by Auto Scaling. They are: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default
The output of the DetachInstances action.
- */ -@interface AWSAutoScalingDetachInstancesAnswer : AWSModel - - -/** -A list describing the activities related to detaching the instances from the Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *activities; - -@end - -/** - - */ -@interface AWSAutoScalingDetachInstancesQuery : AWSRequest - - -/** -The name of the Auto Scaling group from which to detach instances.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -/** - Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
The name or ARN of the Auto Scaling Group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The list of metrics to disable. If no metrics are specified, all metrics are disabled. The following metrics are supported:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The Ebs data type.
- */ -@interface AWSAutoScalingEbs : AWSModel - - -/** -Indicates whether to delete the volume on instance termination.
Default: true
The number of I/O operations per second (IOPS) that the volume supports.
The maximum ratio of IOPS to volume size is 30.0
Valid Values: Range is 100 to 4000.
Default: None.
- */ -@property (nonatomic, strong) NSNumber *iops; - -/** -The snapshot ID.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -/** -The volume size, in gigabytes.
Valid values: If the volume type is io1, the minimum size of the volume is 10.
Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size.
Required: Required when the volume type is io1.
The volume type.
Valid values: standard | io1
Default: standard
The name or ARN of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The granularity to associate with the metrics to collect. Currently, the only legal granularity is "1Minute".
- */ -@property (nonatomic, strong) NSString *granularity; - -/** -The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:
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 EnabledMetric data type.
The granularity of the enabled metric.
- */ -@property (nonatomic, strong) NSString *granularity; - -/** -The name of the enabled metric.
- */ -@property (nonatomic, strong) NSString *metric; - -@end - -/** -The output of the EnterStandby action.
- */ -@interface AWSAutoScalingEnterStandbyAnswer : AWSModel - - -/** -A list describing the activities related to moving instances into Standby mode.
- */ -@property (nonatomic, strong) NSArray *activities; - -@end - -/** - - */ -@interface AWSAutoScalingEnterStandbyQuery : AWSRequest - - -/** -The name of the Auto Scaling group from which to move instances into Standby mode.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The instances to move into Standby mode. You must specify at least one instance ID.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *shouldDecrementDesiredCapacity; - -@end - -/** - - */ -@interface AWSAutoScalingExecutePolicyType : AWSRequest - - -/** -The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.
For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSNumber *honorCooldown; - -/** -The name or ARN of the policy you want to run.
- */ -@property (nonatomic, strong) NSString *policyName; - -@end - -/** -The output of the ExitStandby action.
- */ -@interface AWSAutoScalingExitStandbyAnswer : AWSModel - - -/** -A list describing the activities related to moving instances out of Standby mode.
- */ -@property (nonatomic, strong) NSArray *activities; - -@end - -/** - - */ -@interface AWSAutoScalingExitStandbyQuery : AWSRequest - - -/** -The name of the Auto Scaling group from which to move instances out of Standby mode.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -A list of instances to move out of Standby mode. You must specify at least one instance ID.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** -The Filter data type.
The name of the filter. Valid Name values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".
The value of the filter.
- */ -@property (nonatomic, strong) NSArray *values; - -@end - -/** - The Instance data type.
Availability Zones associated with this instance.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The instance's health status.
- */ -@property (nonatomic, strong) NSString *healthStatus; - -/** -Specifies the ID of the Amazon EC2 instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The launch configuration associated with this instance.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -Contains a description of the current lifecycle state.
The Quarantined lifecycle state is currently not used.
The InstanceMonitoring data type.
If True, instance monitoring is enabled.
The LaunchConfiguration data type.
Specifies whether the instance is associated with a public IP address (true) or not (false).
Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -Provides the creation date and time for this launch configuration.
- */ -@property (nonatomic, strong) NSDate *createdTime; - -/** -Specifies whether the instance is optimized for EBS I/O (true) or not (false).
- */ -@property (nonatomic, strong) NSNumber *ebsOptimized; - -/** -Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
- */ -@property (nonatomic, strong) NSString *iamInstanceProfile; - -/** -Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -Controls whether instances in this group are launched with detailed monitoring or not.
- */ -@property (nonatomic, strong) AWSAutoScalingInstanceMonitoring *instanceMonitoring; - -/** -Specifies the instance type of the Amazon EC2 instance.
- */ -@property (nonatomic, strong) NSString *instanceType; - -/** -Provides the ID of the kernel associated with the Amazon EC2 AMI.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -Provides the name of the Amazon EC2 key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -/** -The launch configuration's Amazon Resource Name (ARN).
- */ -@property (nonatomic, strong) NSString *launchConfigurationARN; - -/** -Specifies the name of the launch configuration.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -Specifies the tenancy of the instance. It can be either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and it can only be launched in a VPC.
Provides ID of the RAM disk associated with the Amazon EC2 AMI.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** -A description of the security groups to associate with the Amazon EC2 instances.
- */ -@property (nonatomic, strong) NSArray *securityGroups; - -/** -Specifies the price to bid when launching Spot Instances.
- */ -@property (nonatomic, strong) NSString *spotPrice; - -/** -The user data available to the launched Amazon EC2 instances.
- */ -@property (nonatomic, strong) NSString *userData; - -@end - -/** - - Required parameters: [LaunchConfigurationName] - */ -@interface AWSAutoScalingLaunchConfigurationNameType : AWSRequest - - -/** -The name of the launch configuration.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -@end - -/** - The LaunchConfigurationNamesType data type.
A list of launch configuration names.
- */ -@property (nonatomic, strong) NSArray *launchConfigurationNames; - -/** -The maximum number of launch configurations. The default is 100.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - The LaunchConfigurationsType data type.
A list of launch configurations.
- */ -@property (nonatomic, strong) NSArray *launchConfigurations; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -A lifecycle hook tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
- */ -@interface AWSAutoScalingLifecycleHook : AWSModel - - -/** -The name of the Auto Scaling group to which the lifecycle action belongs.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is CONTINUE.
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 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 name of the lifecycle action hook.
- */ -@property (nonatomic, strong) NSString *lifecycleHookName; - -/** -The Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHooks for a list of available lifecycle hook types.
- */ -@property (nonatomic, strong) NSString *lifecycleTransition; - -/** -Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
- */ -@property (nonatomic, strong) NSString *notificationMetadata; - -/** -The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target will include:
The ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.
- */ -@property (nonatomic, strong) NSString *roleARN; - -@end - -/** -The MetricCollectionType data type.
- */ -@interface AWSAutoScalingMetricCollectionType : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSString *metric; - -@end - -/** -The MetricGranularityType data type.
- */ -@interface AWSAutoScalingMetricGranularityType : AWSModel - - -/** -The granularity of a Metric.
- */ -@property (nonatomic, strong) NSString *granularity; - -@end - -/** - The NotificationConfiguration data type.
Specifies the Auto Scaling group name.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The types of events for an action to start.
- */ -@property (nonatomic, strong) NSString *notificationType; - -/** -The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
- */ -@property (nonatomic, strong) NSString *topicARN; - -@end - -/** - The PoliciesType data type.
A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of scaling policies.
- */ -@property (nonatomic, strong) NSArray *scalingPolicies; - -@end - -/** - The PolicyARNType data type.
A policy's Amazon Resource Name (ARN).
- */ -@property (nonatomic, strong) NSString *policyARN; - -@end - -/** - There are two primary Auto Scaling process types--Launch and Terminate. The Launch process creates a new Amazon EC2 instance for an Auto Scaling group, and the Terminate process removes an existing Amazon EC2 instance.
The remaining Auto Scaling process types relate to specific Auto Scaling features:
If you suspend Launch or Terminate, all other process types are affected to varying degrees. The following descriptions discuss how each process type is affected by a suspension of Launch or Terminate.
The AddToLoadBalancer process type adds instances to the load balancer when the instances are launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to the load balancer. If you resume the AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load balancer when they are launched. However, Auto Scaling will not add running instances that were launched while the process was suspended; those instances must be added manually using the the RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference.
The AlarmNotification process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the AlarmNotification process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms.
Although the AlarmNotification process type is not directly affected by a suspension of Launch or Terminate, alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend Launch or Terminate, Auto Scaling might not be able to implement the alarm's associated policy.
The AZRebalance process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated Availability Zones.
If you call SuspendProcesses on the launch process type, the AZRebalance process will neither launch new instances nor terminate existing instances. This is because the AZRebalance process terminates existing instances only after launching the replacement instances.
If you call SuspendProcesses on the terminate process type, the AZRebalance process can cause your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could remain up to ten percent larger than the maximum size until you resume the terminate process type.
The HealthCheck process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy. The HealthCheck process can override the health status of an instance that you set with SetInstanceHealth.
The ReplaceUnhealthy process type terminates instances that are marked as unhealthy and subsequently creates new instances to replace them. This process calls both of the primary process types--first Terminate and then Launch.
The HealthCheck process type works in conjunction with the ReplaceUnhealthly process type to provide health check functionality. If you suspend either Launch or Terminate, the ReplaceUnhealthy process type will not function properly.
The ScheduledActions process type performs scheduled actions that you create with PutScheduledUpdateGroupAction. Scheduled actions often involve launching new instances or terminating existing instances. If you suspend either Launch or Terminate, your scheduled actions might not function as expected.
The name of a process.
- */ -@property (nonatomic, strong) NSString *processName; - -@end - -/** -The output of the DescribeScalingProcessTypes action.
- */ -@interface AWSAutoScalingProcessesType : AWSModel - - -/** -A list of ProcessType names.
- */ -@property (nonatomic, strong) NSArray *processes; - -@end - -/** -The output of the PutLifecycleHook action.
- */ -@interface AWSAutoScalingPutLifecycleHookAnswer : AWSModel - - -@end - -/** - - */ -@interface AWSAutoScalingPutLifecycleHookType : AWSRequest - - -/** -The name of the Auto Scaling group to which you want to assign the lifecycle hook.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -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.
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).
The name of the lifecycle hook.
- */ -@property (nonatomic, strong) NSString *lifecycleHookName; - -/** -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.
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
- */ -@property (nonatomic, strong) NSString *notificationMetadata; - -/** -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.
The ARN of the Amazon 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 name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
- */ -@property (nonatomic, strong) NSArray *notificationTypes; - -/** -The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
- */ -@property (nonatomic, strong) NSString *topicARN; - -@end - -/** - - */ -@interface AWSAutoScalingPutScalingPolicyType : AWSRequest - - -/** - Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
For more information about the adjustment types supported by Auto Scaling, see Scale Based on Demand.
- */ -@property (nonatomic, strong) NSString *adjustmentType; - -/** -The name or ARN of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
For more information, see Cooldown Period
- */ -@property (nonatomic, strong) NSNumber *cooldown; - -/** - 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 of the policy you want to create or update.
- */ -@property (nonatomic, strong) NSString *policyName; - -/** - 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.
The name or ARN of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The number of Amazon EC2 instances that should be running in the group.
- */ -@property (nonatomic, strong) NSNumber *desiredCapacity; - -/** -The time for this action to end.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -The maximum size for the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *maxSize; - -/** -The minimum size for the new Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *minSize; - -/** -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 name of this scaling action.
- */ -@property (nonatomic, strong) NSString *scheduledActionName; - -/** -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.
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 output of the RecordLifecycleActionHeartbeat action.
- */ -@interface AWSAutoScalingRecordLifecycleActionHeartbeatAnswer : AWSModel - - -@end - -/** - - */ -@interface AWSAutoScalingRecordLifecycleActionHeartbeatType : AWSRequest - - -/** -The name of the Auto Scaling group to which the hook belongs.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -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.
- */ -@property (nonatomic, strong) NSString *lifecycleActionToken; - -/** -The name of the lifecycle hook.
- */ -@property (nonatomic, strong) NSString *lifecycleHookName; - -@end - -/** - The ScalingPolicy data type.
Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
A list of CloudWatch Alarms related to the policy.
- */ -@property (nonatomic, strong) NSArray *alarms; - -/** -The name of the Auto Scaling group associated with this scaling policy.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
- */ -@property (nonatomic, strong) NSNumber *cooldown; - -/** - Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.
The Amazon Resource Name (ARN) of the policy.
- */ -@property (nonatomic, strong) NSString *policyARN; - -/** -The name of the scaling policy.
- */ -@property (nonatomic, strong) NSString *policyName; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *scalingAdjustment; - -@end - -/** - - */ -@interface AWSAutoScalingScalingProcessQuery : AWSRequest - - -/** -The name or Amazon Resource Name (ARN) of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The processes that you want to suspend or resume, which can include one or more of the following:
To suspend all process types, omit this parameter.
- */ -@property (nonatomic, strong) NSArray *scalingProcesses; - -@end - -/** -A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.
Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occurs regularly on a schedule.
A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of scheduled actions designed to update an Auto Scaling group.
- */ -@property (nonatomic, strong) NSArray *scheduledUpdateGroupActions; - -@end - -/** -This data type stores information about a scheduled update to an Auto Scaling group.
- */ -@interface AWSAutoScalingScheduledUpdateGroupAction : AWSModel - - -/** -The name of the Auto Scaling group to be updated.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The number of instances you prefer to maintain in your Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *desiredCapacity; - -/** -The time that the action is scheduled to end. This value can be up to one month in the future.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -The maximum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *maxSize; - -/** -The minimum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *minSize; - -/** -The regular schedule that an action occurs.
- */ -@property (nonatomic, strong) NSString *recurrence; - -/** -The Amazon Resource Name (ARN) of this scheduled action.
- */ -@property (nonatomic, strong) NSString *scheduledActionARN; - -/** -The name of this scheduled action.
- */ -@property (nonatomic, strong) NSString *scheduledActionName; - -/** -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.
Time is deprecated.
The time that the action is scheduled to begin. Time is an alias for StartTime.
The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -The new capacity setting for the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *desiredCapacity; - -/** - By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to the new capacity setting.
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.
The identifier of the Amazon EC2 instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.
For more information, see the HealthCheckGracePeriod parameter description in the CreateAutoScalingGroup action.
An Auto Scaling process that has been suspended. For more information, see ProcessType.
- */ -@interface AWSAutoScalingSuspendedProcess : AWSModel - - -/** -The name of the suspended process.
- */ -@property (nonatomic, strong) NSString *processName; - -/** -The reason that the process was suspended.
- */ -@property (nonatomic, strong) NSString *suspensionReason; - -@end - -/** -The tag applied to an Auto Scaling group.
- Required parameters: [Key] - */ -@interface AWSAutoScalingTag : AWSModel - - -/** -The key of the tag.
- */ -@property (nonatomic, strong) NSString *key; - -/** -Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.
- */ -@property (nonatomic, strong) NSNumber *propagateAtLaunch; - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *resourceId; - -/** - The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.
The value of the tag.
- */ -@property (nonatomic, strong) NSString *value; - -@end - -/** -The tag applied to an Auto Scaling group.
- */ -@interface AWSAutoScalingTagDescription : AWSModel - - -/** -The key of the tag.
- */ -@property (nonatomic, strong) NSString *key; - -/** -Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.
- */ -@property (nonatomic, strong) NSNumber *propagateAtLaunch; - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *resourceId; - -/** - The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.
The value of the tag.
- */ -@property (nonatomic, strong) NSString *value; - -@end - -/** - - */ -@interface AWSAutoScalingTagsType : AWSModel - - -/** -A string used to mark the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -The list of tags.
- */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** - - Required parameters: [InstanceId, ShouldDecrementDesiredCapacity] - */ -@interface AWSAutoScalingTerminateInstanceInAutoScalingGroupType : AWSRequest - - -/** -The ID of the Amazon EC2 instance to be terminated.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -Specifies whether (true) or not (false) terminating this instance should also decrement the size of the AutoScalingGroup.
- */ -@property (nonatomic, strong) NSNumber *shouldDecrementDesiredCapacity; - -@end - -/** - - Required parameters: [AutoScalingGroupName] - */ -@interface AWSAutoScalingUpdateAutoScalingGroupType : AWSRequest - - -/** -The name of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSString *autoScalingGroupName; - -/** -Availability Zones for the group.
- */ -@property (nonatomic, strong) NSArray *availabilityZones; - -/** -The amount of time, in seconds, after a scaling activity completes before any further scaling activities can start. For more information, see Cooldown Period.
- */ -@property (nonatomic, strong) NSNumber *defaultCooldown; - -/** -The desired capacity for the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *desiredCapacity; - -/** -The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when the instance passes System Status and the Instance Status checks from Amazon EC2. For more information, see DescribeInstanceStatus.
- */ -@property (nonatomic, strong) NSNumber *healthCheckGracePeriod; - -/** - 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 name of the launch configuration.
- */ -@property (nonatomic, strong) NSString *launchConfigurationName; - -/** -The maximum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *maxSize; - -/** -The minimum size of the Auto Scaling group.
- */ -@property (nonatomic, strong) NSNumber *minSize; - -/** -The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.
- */ -@property (nonatomic, strong) NSString *placementGroup; - -/** -A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSArray *terminationPolicies; - -/** -The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.
When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.
For more information on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.
- */ -@property (nonatomic, strong) NSString *VPCZoneIdentifier; - -@end diff --git a/Frameworks/AWSAutoScaling.framework/Headers/AWSAutoScalingService.h b/Frameworks/AWSAutoScaling.framework/Headers/AWSAutoScalingService.h deleted file mode 100644 index 7b64a30..0000000 --- a/Frameworks/AWSAutoScaling.framework/Headers/AWSAutoScalingService.h +++ /dev/null @@ -1,705 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importAuto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. This service is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services.
Auto Scaling provides APIs that you can call by submitting a Query Request. Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named Action or Operation that specifies the API you are calling. Action is used throughout this documentation, although Operation is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs.
Calling the API using a Query request is the most direct way to access the web service, but requires that your application handle low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a Query request is that you are assured of having access to the complete functionality of the API. For information about signing a a query request, see Use Query Requests to Call Auto Scaling APIs
This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API actions, go to the Auto Scaling Developer Guide.
This reference is based on the current WSDL, which is available at:
http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl
Endpoints
The examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
You can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
- */ -@interface AWSAutoScaling : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let AutoScaling = AWSAutoScaling.defaultAutoScaling() - - *Objective-C* - - AWSAutoScaling *AutoScaling = [AWSAutoScaling defaultAutoScaling]; - - @return The default service client. - */ -+ (instancetype)defaultAutoScaling; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSAutoScaling.registerAutoScalingWithConfiguration(configuration, forKey: "USWest2AutoScaling") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSAutoScaling registerAutoScalingWithConfiguration:configuration forKey:@"USWest2AutoScaling"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let AutoScaling = AWSAutoScaling(forKey: "USWest2AutoScaling") - - *Objective-C* - - AWSAutoScaling *AutoScaling = [AWSAutoScaling AutoScalingForKey:@"USWest2AutoScaling"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerAutoScalingWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerAutoScalingWithConfiguration:forKey:` before invoking this method. If `+ registerAutoScalingWithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSAutoScaling.registerAutoScalingWithConfiguration(configuration, forKey: "USWest2AutoScaling") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSAutoScaling registerAutoScalingWithConfiguration:configuration forKey:@"USWest2AutoScaling"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let AutoScaling = AWSAutoScaling(forKey: "USWest2AutoScaling") - - *Objective-C* - - AWSAutoScaling *AutoScaling = [AWSAutoScaling AutoScalingForKey:@"USWest2AutoScaling"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)AutoScalingForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeAutoScalingForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerAutoScalingWithConfiguration:forKey:` and `+ AutoScalingForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerAutoScalingWithConfiguration:forKey:' and '+ AutoScalingForKey:' instead."))); - -/** -Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group.
For more information, see Attach Amazon EC2 Instances to Your Existing Auto Scaling Group in the Auto Scaling Developer Guide.
- - @param request A container for the necessary parameters to execute the AttachInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingAttachInstancesQuery - */ -- (BFTask *)attachInstances:(AWSAutoScalingAttachInstancesQuery *)request; - -/** -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:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
- - @param request A container for the necessary parameters to execute the CompleteLifecycleAction service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingCompleteLifecycleActionAnswer`. - - @see AWSAutoScalingCompleteLifecycleActionType - @see AWSAutoScalingCompleteLifecycleActionAnswer - */ -- (BFTask *)completeLifecycleAction:(AWSAutoScalingCompleteLifecycleActionType *)request; - -/** -Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.
Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use.
- - @param request A container for the necessary parameters to execute the CreateLaunchConfiguration service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorAlreadyExists`, `AWSAutoScalingErrorLimitExceeded`. - - @see AWSAutoScalingCreateLaunchConfigurationType - */ -- (BFTask *)createLaunchConfiguration:(AWSAutoScalingCreateLaunchConfigurationType *)request; - -/** -Creates new tags or updates existing tags for an Auto Scaling group.
For information on creating tags for your Auto Scaling group, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
- - @param request A container for the necessary parameters to execute the CreateOrUpdateTags service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorLimitExceeded`, `AWSAutoScalingErrorAlreadyExists`. - - @see AWSAutoScalingCreateOrUpdateTagsType - */ -- (BFTask *)createOrUpdateTags:(AWSAutoScalingCreateOrUpdateTagsType *)request; - -/** -Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.
Deletes the specified LaunchConfiguration.
The specified launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
- - @param request A container for the necessary parameters to execute the DeleteLaunchConfiguration service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorResourceInUse`. - - @see AWSAutoScalingLaunchConfigurationNameType - */ -- (BFTask *)deleteLaunchConfiguration:(AWSAutoScalingLaunchConfigurationNameType *)request; - -/** -Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
- - @param request A container for the necessary parameters to execute the DeleteLifecycleHook service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDeleteLifecycleHookAnswer`. - - @see AWSAutoScalingDeleteLifecycleHookType - @see AWSAutoScalingDeleteLifecycleHookAnswer - */ -- (BFTask *)deleteLifecycleHook:(AWSAutoScalingDeleteLifecycleHookType *)request; - -/** -Deletes notifications created by PutNotificationConfiguration.
- - @param request A container for the necessary parameters to execute the DeleteNotificationConfiguration service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingDeleteNotificationConfigurationType - */ -- (BFTask *)deleteNotificationConfiguration:(AWSAutoScalingDeleteNotificationConfigurationType *)request; - -/** -Deletes a policy created by PutScalingPolicy.
- - @param request A container for the necessary parameters to execute the DeletePolicy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingDeletePolicyType - */ -- (BFTask *)deletePolicy:(AWSAutoScalingDeletePolicyType *)request; - -/** -Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
- - @param request A container for the necessary parameters to execute the DeleteScheduledAction service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingDeleteScheduledActionType - */ -- (BFTask *)deleteScheduledAction:(AWSAutoScalingDeleteScheduledActionType *)request; - -/** -Removes the specified tags or a set of tags from a set of resources.
- - @param request A container for the necessary parameters to execute the DeleteTags service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingDeleteTagsType - */ -- (BFTask *)deleteTags:(AWSAutoScalingDeleteTagsType *)request; - -/** -Returns the limits for the Auto Scaling resources currently allowed for your AWS account.
Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of 20 Auto Scaling groups and 100 launch configurations per region.
If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the Support Center and place a request to raise the limits.
- - @param request A container for the necessary parameters to execute the DescribeAccountLimits service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeAccountLimitsAnswer`. - - @see AWSRequest - @see AWSAutoScalingDescribeAccountLimitsAnswer - */ -- (BFTask *)describeAccountLimits:(AWSRequest *)request; - -/** -Returns policy adjustment types for use in the PutScalingPolicy action.
- - @param request A container for the necessary parameters to execute the DescribeAdjustmentTypes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeAdjustmentTypesAnswer`. - - @see AWSRequest - @see AWSAutoScalingDescribeAdjustmentTypesAnswer - */ -- (BFTask *)describeAdjustmentTypes:(AWSRequest *)request; - -/** -Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.
This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.
This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
Returns a list of all notification types that are supported by Auto Scaling.
- - @param request A container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer`. - - @see AWSRequest - @see AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer - */ -- (BFTask *)describeAutoScalingNotificationTypes:(AWSRequest *)request; - -/** -Returns a full description of the launch configurations, or the specified launch configurations, if they exist.
If no name is specified, then the full details of all launch configurations are returned.
- - @param request A container for the necessary parameters to execute the DescribeLaunchConfigurations service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingLaunchConfigurationsType`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorInvalidNextToken`. - - @see AWSAutoScalingLaunchConfigurationNamesType - @see AWSAutoScalingLaunchConfigurationsType - */ -- (BFTask *)describeLaunchConfigurations:(AWSAutoScalingLaunchConfigurationNamesType *)request; - -/** -Describes the available types of lifecycle hooks.
- - @param request A container for the necessary parameters to execute the DescribeLifecycleHookTypes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeLifecycleHookTypesAnswer`. - - @see AWSRequest - @see AWSAutoScalingDescribeLifecycleHookTypesAnswer - */ -- (BFTask *)describeLifecycleHookTypes:(AWSRequest *)request; - -/** -Describes the lifecycle hooks that currently belong to the specified Auto Scaling group.
- - @param request A container for the necessary parameters to execute the DescribeLifecycleHooks service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeLifecycleHooksAnswer`. - - @see AWSAutoScalingDescribeLifecycleHooksType - @see AWSAutoScalingDescribeLifecycleHooksAnswer - */ -- (BFTask *)describeLifecycleHooks:(AWSAutoScalingDescribeLifecycleHooksType *)request; - -/** -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.
Returns a list of notification actions associated with Auto Scaling groups for specified events.
- - @param request A container for the necessary parameters to execute the DescribeNotificationConfigurations service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeNotificationConfigurationsAnswer`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorInvalidNextToken`. - - @see AWSAutoScalingDescribeNotificationConfigurationsType - @see AWSAutoScalingDescribeNotificationConfigurationsAnswer - */ -- (BFTask *)describeNotificationConfigurations:(AWSAutoScalingDescribeNotificationConfigurationsType *)request; - -/** - Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Returns the scaling activities for the specified Auto Scaling group.
If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list.
This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
- - @param request A container for the necessary parameters to execute the DescribeScalingProcessTypes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingProcessesType`. - - @see AWSRequest - @see AWSAutoScalingProcessesType - */ -- (BFTask *)describeScalingProcessTypes:(AWSRequest *)request; - -/** -Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.
- - @param request A container for the necessary parameters to execute the DescribeScheduledActions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingScheduledActionsType`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorInvalidNextToken`. - - @see AWSAutoScalingDescribeScheduledActionsType - @see AWSAutoScalingScheduledActionsType - */ -- (BFTask *)describeScheduledActions:(AWSAutoScalingDescribeScheduledActionsType *)request; - -/** -Lists the Auto Scaling group tags.
You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there's no match, no special message is returned.
- - @param request A container for the necessary parameters to execute the DescribeTags service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingTagsType`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorInvalidNextToken`. - - @see AWSAutoScalingDescribeTagsType - @see AWSAutoScalingTagsType - */ -- (BFTask *)describeTags:(AWSAutoScalingDescribeTagsType *)request; - -/** -Returns a list of all termination policies supported by Auto Scaling.
- - @param request A container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDescribeTerminationPolicyTypesAnswer`. - - @see AWSRequest - @see AWSAutoScalingDescribeTerminationPolicyTypesAnswer - */ -- (BFTask *)describeTerminationPolicyTypes:(AWSRequest *)request; - -/** -Using DetachInstances, you can remove an instance from an Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
To learn more about detaching instances, see Detach Amazon EC2 Instances From Your Auto Scaling Group.
- - @param request A container for the necessary parameters to execute the DetachInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingDetachInstancesAnswer`. - - @see AWSAutoScalingDetachInstancesQuery - @see AWSAutoScalingDetachInstancesAnswer - */ -- (BFTask *)detachInstances:(AWSAutoScalingDetachInstancesQuery *)request; - -/** - Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of affected metrics with the Metrics parameter.
Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled metrics with the Metrics parameter.
Auto Scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the Auto Scaling group's launch configuration, is set to True.
Move instances in an Auto Scaling group into a Standby mode.
To learn more about how to put instances into a Standby mode, see Auto Scaling InService State.
- - @param request A container for the necessary parameters to execute the EnterStandby service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingEnterStandbyAnswer`. - - @see AWSAutoScalingEnterStandbyQuery - @see AWSAutoScalingEnterStandbyAnswer - */ -- (BFTask *)enterStandby:(AWSAutoScalingEnterStandbyQuery *)request; - -/** -Executes the specified policy.
- - @param request A container for the necessary parameters to execute the ExecutePolicy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorScalingActivityInProgress`. - - @see AWSAutoScalingExecutePolicyType - */ -- (BFTask *)executePolicy:(AWSAutoScalingExecutePolicyType *)request; - -/** -Move an instance out of Standby mode.
To learn more about how to put instances that are in a Standby mode back into service, see Auto Scaling InService State.
- - @param request A container for the necessary parameters to execute the ExitStandby service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingExitStandbyAnswer`. - - @see AWSAutoScalingExitStandbyQuery - @see AWSAutoScalingExitStandbyAnswer - */ -- (BFTask *)exitStandby:(AWSAutoScalingExitStandbyQuery *)request; - -/** -Creates or updates a lifecycle hook for an Auto Scaling Group.
A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
- - @param request A container for the necessary parameters to execute the PutLifecycleHook service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingPutLifecycleHookAnswer`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorLimitExceeded`. - - @see AWSAutoScalingPutLifecycleHookType - @see AWSAutoScalingPutLifecycleHookAnswer - */ -- (BFTask *)putLifecycleHook:(AWSAutoScalingPutLifecycleHookType *)request; - -/** -Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.
For more information see Get Email Notifications When Your Auto Scaling Group Changes
A new PutNotificationConfiguration overwrites an existing configuration.
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
- - @param request A container for the necessary parameters to execute the PutScalingPolicy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingPolicyARNType`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorLimitExceeded`. - - @see AWSAutoScalingPutScalingPolicyType - @see AWSAutoScalingPolicyARNType - */ -- (BFTask *)putScalingPolicy:(AWSAutoScalingPutScalingPolicyType *)request; - -/** -Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.
For information on creating or updating a scheduled action for your Auto Scaling group, see Scale Based on a Schedule.
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 the PutLifecycleHook operation.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
- - @param request A container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSAutoScalingRecordLifecycleActionHeartbeatAnswer`. - - @see AWSAutoScalingRecordLifecycleActionHeartbeatType - @see AWSAutoScalingRecordLifecycleActionHeartbeatAnswer - */ -- (BFTask *)recordLifecycleActionHeartbeat:(AWSAutoScalingRecordLifecycleActionHeartbeatType *)request; - -/** -Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.
- - @param request A container for the necessary parameters to execute the ResumeProcesses service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingScalingProcessQuery - */ -- (BFTask *)resumeProcesses:(AWSAutoScalingScalingProcessQuery *)request; - -/** -Sets the desired size of the specified AutoScalingGroup.
- - @param request A container for the necessary parameters to execute the SetDesiredCapacity service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSAutoScalingErrorDomain` domian and the following error code: `AWSAutoScalingErrorScalingActivityInProgress`. - - @see AWSAutoScalingSetDesiredCapacityType - */ -- (BFTask *)setDesiredCapacity:(AWSAutoScalingSetDesiredCapacityType *)request; - -/** -Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.
For more information, see Configure Health Checks for Your Auto Scaling group.
- - @param request A container for the necessary parameters to execute the SetInstanceHealth service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingSetInstanceHealthQuery - */ -- (BFTask *)setInstanceHealth:(AWSAutoScalingSetInstanceHealthQuery *)request; - -/** - Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.
Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from functioning properly.
To resume processes that have been suspended, use ResumeProcesses For more information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.
- - @param request A container for the necessary parameters to execute the SuspendProcesses service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSAutoScalingScalingProcessQuery - */ -- (BFTask *)suspendProcesses:(AWSAutoScalingScalingProcessQuery *)request; - -/** -Terminates the specified instance. Optionally, the desired group size can be adjusted.
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.
Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. This service is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services.
Auto Scaling provides APIs that you can call by submitting a Query Request. Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named Action or Operation that specifies the API you are calling. Action is used throughout this documentation, although Operation is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs.
Calling the API using a Query request is the most direct way to access the web service, but requires that your application handle low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a Query request is that you are assured of having access to the complete functionality of the API. For information about signing a a query request, see Use Query Requests to Call Auto Scaling APIs
This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API actions, go to the Auto Scaling Developer Guide.
This reference is based on the current WSDL, which is available at:
http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl
Endpoints
The examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
You can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
", - "operations":{ - "AttachInstances":{ - "name":"AttachInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AttachInstancesQuery"}, - "documentation":"Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group.
For more information, see Attach Amazon EC2 Instances to Your Existing Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "CompleteLifecycleAction":{ - "name":"CompleteLifecycleAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CompleteLifecycleActionType"}, - "output":{ - "shape":"CompleteLifecycleActionAnswer", - "documentation":"The output of the CompleteLifecycleAction.
", - "resultWrapper":"CompleteLifecycleActionResult" - }, - "documentation":"Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
" - }, - "CreateAutoScalingGroup":{ - "name":"CreateAutoScalingGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateAutoScalingGroupType", - "documentation":"" - }, - "errors":[ - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The named Auto Scaling group or launch configuration already exists.
" - }, - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for capacity groups or launch configurations for this customer has already been reached.
" - } - ], - "documentation":"Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.
" - }, - "errors":[ - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The named Auto Scaling group or launch configuration already exists.
" - }, - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for capacity groups or launch configurations for this customer has already been reached.
" - } - ], - "documentation":"Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use.
" - }, - "CreateOrUpdateTags":{ - "name":"CreateOrUpdateTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"CreateOrUpdateTagsType", - "documentation":"" - }, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The quota for capacity groups or launch configurations for this customer has already been reached.
" - }, - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The named Auto Scaling group or launch configuration already exists.
" - } - ], - "documentation":"Creates new tags or updates existing tags for an Auto Scaling group.
For information on creating tags for your Auto Scaling group, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
" - }, - "DeleteAutoScalingGroup":{ - "name":"DeleteAutoScalingGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteAutoScalingGroupType", - "documentation":"" - }, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
" - }, - { - "shape":"ResourceInUseFault", - "error":{ - "code":"ResourceInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used.
" - } - ], - "documentation":"Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.
" - }, - "errors":[ - { - "shape":"ResourceInUseFault", - "error":{ - "code":"ResourceInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used.
" - } - ], - "documentation":"Deletes the specified LaunchConfiguration.
The specified launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
" - }, - "DeleteLifecycleHook":{ - "name":"DeleteLifecycleHook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteLifecycleHookType"}, - "output":{ - "shape":"DeleteLifecycleHookAnswer", - "documentation":"The output of the DeleteLifecycleHook action.
", - "resultWrapper":"DeleteLifecycleHookResult" - }, - "documentation":"Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
" - }, - "DeleteNotificationConfiguration":{ - "name":"DeleteNotificationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteNotificationConfigurationType", - "documentation":"" - }, - "documentation":"Deletes notifications created by PutNotificationConfiguration.
" - }, - "DeletePolicy":{ - "name":"DeletePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeletePolicyType", - "documentation":"" - }, - "documentation":"Deletes a policy created by PutScalingPolicy.
" - }, - "DeleteScheduledAction":{ - "name":"DeleteScheduledAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteScheduledActionType", - "documentation":"" - }, - "documentation":"Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
" - }, - "DeleteTags":{ - "name":"DeleteTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DeleteTagsType", - "documentation":"" - }, - "documentation":"
Removes the specified tags or a set of tags from a set of resources.
" - }, - "DescribeAccountLimits":{ - "name":"DescribeAccountLimits", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeAccountLimitsAnswer", - "documentation":"The output of the DescribeAccountLimitsResult action.
", - "resultWrapper":"DescribeAccountLimitsResult" - }, - "documentation":"Returns the limits for the Auto Scaling resources currently allowed for your AWS account.
Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of 20 Auto Scaling groups and 100 launch configurations per region.
If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the Support Center and place a request to raise the limits.
" - }, - "DescribeAdjustmentTypes":{ - "name":"DescribeAdjustmentTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeAdjustmentTypesAnswer", - "documentation":"The output of the DescribeAdjustmentTypes action.
", - "resultWrapper":"DescribeAdjustmentTypesResult" - }, - "documentation":"Returns policy adjustment types for use in the PutScalingPolicy action.
" - }, - "DescribeAutoScalingGroups":{ - "name":"DescribeAutoScalingGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"AutoScalingGroupNamesType", - "documentation":" The AutoScalingGroupNamesType data type.
The AutoScalingGroupsType data type.
The NextToken value is invalid.
Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.
This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
The AutoScalingInstancesType data type.
The NextToken value is invalid.
Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.
This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.
The AutoScalingNotificationTypes data type.
Returns a list of all notification types that are supported by Auto Scaling.
" - }, - "DescribeLaunchConfigurations":{ - "name":"DescribeLaunchConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"LaunchConfigurationNamesType", - "documentation":" The LaunchConfigurationNamesType data type.
The LaunchConfigurationsType data type.
The NextToken value is invalid.
Returns a full description of the launch configurations, or the specified launch configurations, if they exist.
If no name is specified, then the full details of all launch configurations are returned.
" - }, - "DescribeLifecycleHookTypes":{ - "name":"DescribeLifecycleHookTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeLifecycleHookTypesAnswer", - "resultWrapper":"DescribeLifecycleHookTypesResult" - }, - "documentation":"Describes the available types of lifecycle hooks.
" - }, - "DescribeLifecycleHooks":{ - "name":"DescribeLifecycleHooks", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeLifecycleHooksType"}, - "output":{ - "shape":"DescribeLifecycleHooksAnswer", - "documentation":"The output of the DescribeLifecycleHooks action.
", - "resultWrapper":"DescribeLifecycleHooksResult" - }, - "documentation":"Describes the lifecycle hooks that currently belong to the specified Auto Scaling group.
" - }, - "DescribeMetricCollectionTypes":{ - "name":"DescribeMetricCollectionTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeMetricCollectionTypesAnswer", - "documentation":"The output of the DescribeMetricCollectionTypes action.
", - "resultWrapper":"DescribeMetricCollectionTypesResult" - }, - "documentation":"Returns a list of metrics and a corresponding list of granularities for each metric.
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
The output of the DescribeNotificationConfigurations action.
", - "resultWrapper":"DescribeNotificationConfigurationsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The NextToken value is invalid.
Returns a list of notification actions associated with Auto Scaling groups for specified events.
" - }, - "DescribePolicies":{ - "name":"DescribePolicies", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribePoliciesType"}, - "output":{ - "shape":"PoliciesType", - "documentation":" The PoliciesType data type.
The NextToken value is invalid.
Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
" - }, - "output":{ - "shape":"ActivitiesType", - "documentation":"
The output for the DescribeScalingActivities action.
", - "resultWrapper":"DescribeScalingActivitiesResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":" The NextToken value is invalid.
Returns the scaling activities for the specified Auto Scaling group.
If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list.
This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.
The output of the DescribeScalingProcessTypes action.
", - "resultWrapper":"DescribeScalingProcessTypesResult" - }, - "documentation":"Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
" - }, - "DescribeScheduledActions":{ - "name":"DescribeScheduledActions", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeScheduledActionsType"}, - "output":{ - "shape":"ScheduledActionsType", - "documentation":"A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.
Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occurs regularly on a schedule.
The NextToken value is invalid.
Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.
" - }, - "DescribeTags":{ - "name":"DescribeTags", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"DescribeTagsType", - "documentation":"" - }, - "output":{ - "shape":"TagsType", - "documentation":"
", - "resultWrapper":"DescribeTagsResult" - }, - "errors":[ - { - "shape":"InvalidNextToken", - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The NextToken value is invalid.
Lists the Auto Scaling group tags.
You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there's no match, no special message is returned.
" - }, - "DescribeTerminationPolicyTypes":{ - "name":"DescribeTerminationPolicyTypes", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "output":{ - "shape":"DescribeTerminationPolicyTypesAnswer", - "documentation":"The TerminationPolicyTypes data type.
Returns a list of all termination policies supported by Auto Scaling.
" - }, - "DetachInstances":{ - "name":"DetachInstances", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DetachInstancesQuery"}, - "output":{ - "shape":"DetachInstancesAnswer", - "documentation":"The output of the DetachInstances action.
", - "resultWrapper":"DetachInstancesResult" - }, - "documentation":"Using DetachInstances, you can remove an instance from an Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
To learn more about detaching instances, see Detach Amazon EC2 Instances From Your Auto Scaling Group.
" - }, - "DisableMetricsCollection":{ - "name":"DisableMetricsCollection", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DisableMetricsCollectionQuery"}, - "documentation":" Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of affected metrics with the Metrics parameter.
Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled metrics with the Metrics parameter.
Auto Scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the Auto Scaling group's launch configuration, is set to True.
The output of the EnterStandby action.
", - "resultWrapper":"EnterStandbyResult" - }, - "documentation":"Move instances in an Auto Scaling group into a Standby mode.
To learn more about how to put instances into a Standby mode, see Auto Scaling InService State.
" - }, - "ExecutePolicy":{ - "name":"ExecutePolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ExecutePolicyType"}, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
" - } - ], - "documentation":"Executes the specified policy.
" - }, - "ExitStandby":{ - "name":"ExitStandby", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ExitStandbyQuery"}, - "output":{ - "shape":"ExitStandbyAnswer", - "documentation":"The output of the ExitStandby action.
", - "resultWrapper":"ExitStandbyResult" - }, - "documentation":"Move an instance out of Standby mode.
To learn more about how to put instances that are in a Standby mode back into service, see Auto Scaling InService State.
" - }, - "PutLifecycleHook":{ - "name":"PutLifecycleHook", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutLifecycleHookType"}, - "output":{ - "shape":"PutLifecycleHookAnswer", - "documentation":"The output of the PutLifecycleHook action.
", - "resultWrapper":"PutLifecycleHookResult" - }, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for capacity groups or launch configurations for this customer has already been reached.
" - } - ], - "documentation":"Creates or updates a lifecycle hook for an Auto Scaling Group.
A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
" - }, - "PutNotificationConfiguration":{ - "name":"PutNotificationConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutNotificationConfigurationType"}, - "errors":[ - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for capacity groups or launch configurations for this customer has already been reached.
" - } - ], - "documentation":"Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.
For more information see Get Email Notifications When Your Auto Scaling Group Changes
A new PutNotificationConfiguration overwrites an existing configuration.
The PolicyARNType data type.
The quota for capacity groups or launch configurations for this customer has already been reached.
" - } - ], - "documentation":"Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
" - }, - "PutScheduledUpdateGroupAction":{ - "name":"PutScheduledUpdateGroupAction", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutScheduledUpdateGroupActionType"}, - "errors":[ - { - "shape":"AlreadyExistsFault", - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The named Auto Scaling group or launch configuration already exists.
" - }, - { - "shape":"LimitExceededFault", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The quota for capacity groups or launch configurations for this customer has already been reached.
" - } - ], - "documentation":"Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.
For information on creating or updating a scheduled action for your Auto Scaling group, see Scale Based on a Schedule.
Auto Scaling supports the date and time expressed in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only.
The output of the RecordLifecycleActionHeartbeat action.
", - "resultWrapper":"RecordLifecycleActionHeartbeatResult" - }, - "documentation":" Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of the PutLifecycleHook operation.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
" - }, - "ResumeProcesses":{ - "name":"ResumeProcesses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ScalingProcessQuery"}, - "documentation":"Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.
" - }, - "SetDesiredCapacity":{ - "name":"SetDesiredCapacity", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"SetDesiredCapacityType", - "documentation":"" - }, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
" - } - ], - "documentation":"Sets the desired size of the specified AutoScalingGroup.
" - }, - "SetInstanceHealth":{ - "name":"SetInstanceHealth", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"SetInstanceHealthQuery"}, - "documentation":"Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.
For more information, see Configure Health Checks for Your Auto Scaling group.
" - }, - "SuspendProcesses":{ - "name":"SuspendProcesses", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ScalingProcessQuery"}, - "documentation":" Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.
Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from functioning properly.
To resume processes that have been suspended, use ResumeProcesses For more information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.
" - }, - "TerminateInstanceInAutoScalingGroup":{ - "name":"TerminateInstanceInAutoScalingGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{ - "shape":"TerminateInstanceInAutoScalingGroupType", - "documentation":"" - }, - "output":{ - "shape":"ActivityType", - "documentation":"
The output for the TerminateInstanceInAutoScalingGroup action.
", - "resultWrapper":"TerminateInstanceInAutoScalingGroupResult" - }, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
" - } - ], - "documentation":"Terminates the specified instance. Optionally, the desired group size can be adjusted.
" - }, - "errors":[ - { - "shape":"ScalingActivityInProgressFault", - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
" - } - ], - "documentation":"Updates the configuration for the specified AutoScalingGroup.
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.
A list of the requested scaling activities.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"Acts as a paging mechanism for large result sets. Set to a non-empty string if there are additional results waiting to be returned. Pass this in to subsequent calls to return additional results.
" - } - }, - "documentation":"The output for the DescribeScalingActivities action.
" - }, - "Activity":{ - "type":"structure", - "required":[ - "ActivityId", - "AutoScalingGroupName", - "Cause", - "StartTime", - "StatusCode" - ], - "members":{ - "ActivityId":{ - "shape":"XmlString", - "documentation":"Specifies the ID of the activity.
" - }, - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Auto Scaling group.
" - }, - "Description":{ - "shape":"XmlString", - "documentation":"Contains a friendly, more verbose description of the scaling activity.
" - }, - "Cause":{ - "shape":"XmlStringMaxLen1023", - "documentation":"Contains the reason the activity was begun.
" - }, - "StartTime":{ - "shape":"TimestampType", - "documentation":"Provides the start time of this activity.
" - }, - "EndTime":{ - "shape":"TimestampType", - "documentation":"Provides the end time of this activity.
" - }, - "StatusCode":{ - "shape":"ScalingActivityStatusCode", - "documentation":"Contains the current status of the activity.
" - }, - "StatusMessage":{ - "shape":"XmlStringMaxLen255", - "documentation":"Contains a friendly, more verbose description of the activity status.
" - }, - "Progress":{ - "shape":"Progress", - "documentation":"Specifies a value between 0 and 100 that indicates the progress of the activity.
" - }, - "Details":{ - "shape":"XmlString", - "documentation":"Contains details of the scaling activity.
" - } - }, - "documentation":"A scaling Activity is a long-running process that represents a change to your AutoScalingGroup, such as changing the size of the group. It can also be a process to replace an instance, or a process to perform any other long-running operations supported by the API.
" - }, - "ActivityIds":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "ActivityType":{ - "type":"structure", - "members":{ - "Activity":{ - "shape":"Activity", - "documentation":"A scaling Activity.
" - } - }, - "documentation":"The output for the TerminateInstanceInAutoScalingGroup action.
" - }, - "AdjustmentType":{ - "type":"structure", - "members":{ - "AdjustmentType":{ - "shape":"XmlStringMaxLen255", - "documentation":"A policy adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Specifies whether the PutScalingPolicy ScalingAdjustment parameter is an absolute number or a percentage of the current capacity.
The name of the alarm.
" - }, - "AlarmARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the alarm.
" - } - }, - "documentation":"The Alarm data type.
" - }, - "Alarms":{ - "type":"list", - "member":{"shape":"Alarm"} - }, - "AlreadyExistsFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"XmlStringMaxLen255", - "documentation":"" - } - }, - "error":{ - "code":"AlreadyExists", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The named Auto Scaling group or launch configuration already exists.
" - }, - "AsciiStringMaxLen255":{ - "type":"string", - "min":1, - "max":255, - "pattern":"[A-Za-z0-9\\-_\\/]+" - }, - "AssociatePublicIpAddress":{"type":"boolean"}, - "AttachInstancesQuery":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"One or more IDs of the Amazon EC2 instances to attach to the specified Auto Scaling group. You must specify at least one instance ID.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which to attach the specified instance(s).
" - } - } - }, - "AutoScalingGroup":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "LaunchConfigurationName", - "MinSize", - "MaxSize", - "DesiredCapacity", - "DefaultCooldown", - "AvailabilityZones", - "HealthCheckType", - "CreatedTime" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"Specifies the name of the group.
" - }, - "AutoScalingGroupARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the Auto Scaling group.
" - }, - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"Specifies the name of the associated LaunchConfiguration.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"Contains the minimum size of the Auto Scaling group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"Contains the maximum size of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"Specifies the desired capacity for the Auto Scaling group.
" - }, - "DefaultCooldown":{ - "shape":"Cooldown", - "documentation":"The number of seconds after a scaling activity completes before any further scaling activities can start.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"Contains a list of Availability Zones for the group.
" - }, - "LoadBalancerNames":{ - "shape":"LoadBalancerNames", - "documentation":"A list of load balancers associated with this Auto Scaling group.
" - }, - "HealthCheckType":{ - "shape":"XmlStringMaxLen32", - "documentation":"The service of interest for the health status check, either \"EC2\" for Amazon EC2 or \"ELB\" for Elastic Load Balancing.
" - }, - "HealthCheckGracePeriod":{ - "shape":"HealthCheckGracePeriod", - "documentation":"The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service.
" - }, - "Instances":{ - "shape":"Instances", - "documentation":"Provides a summary list of Amazon EC2 instances.
" - }, - "CreatedTime":{ - "shape":"TimestampType", - "documentation":"Specifies the date and time the Auto Scaling group was created.
" - }, - "SuspendedProcesses":{ - "shape":"SuspendedProcesses", - "documentation":"Suspended processes associated with this Auto Scaling group.
" - }, - "PlacementGroup":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.
" - }, - "VPCZoneIdentifier":{ - "shape":"XmlStringMaxLen255", - "documentation":"The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.
When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.
A list of metrics enabled for this Auto Scaling group.
" - }, - "Status":{ - "shape":"XmlStringMaxLen255", - "documentation":"The current state of the Auto Scaling group when a DeleteAutoScalingGroup action is in progress.
" - }, - "Tags":{ - "shape":"TagDescriptionList", - "documentation":"A list of tags for the Auto Scaling group.
" - }, - "TerminationPolicies":{ - "shape":"TerminationPolicies", - "documentation":"A standalone termination policy or a list of termination policies for this Auto Scaling group.
" - } - }, - "documentation":"The AutoScalingGroup data type.
" - }, - "AutoScalingGroupDesiredCapacity":{"type":"integer"}, - "AutoScalingGroupMaxSize":{"type":"integer"}, - "AutoScalingGroupMinSize":{"type":"integer"}, - "AutoScalingGroupNames":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "AutoScalingGroupNamesType":{ - "type":"structure", - "members":{ - "AutoScalingGroupNames":{ - "shape":"AutoScalingGroupNames", - "documentation":"A list of Auto Scaling group names.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of records to return.
" - } - }, - "documentation":" The AutoScalingGroupNamesType data type.
A list of Auto Scaling groups.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":" The AutoScalingGroupsType data type.
The instance ID of the Amazon EC2 instance.
" - }, - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Auto Scaling group associated with this instance.
" - }, - "AvailabilityZone":{ - "shape":"XmlStringMaxLen255", - "documentation":"The Availability Zone in which this instance resides.
" - }, - "LifecycleState":{ - "shape":"XmlStringMaxLen32", - "documentation":"The life cycle state of this instance. for more information, see Instance Lifecycle State in the Auto Scaling Developer Guide.
" - }, - "HealthStatus":{ - "shape":"XmlStringMaxLen32", - "documentation":"The health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy. Auto Scaling should terminate and replace it.
" - }, - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The launch configuration associated with this instance.
" - } - }, - "documentation":" The AutoScalingInstanceDetails data type.
A list of Auto Scaling instances.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":" The AutoScalingInstancesType data type.
The virtual name associated with the device.
" - }, - "DeviceName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the device within Amazon EC2 (for example, /dev/sdh or xvdh).
" - }, - "Ebs":{ - "shape":"Ebs", - "documentation":"The Elastic Block Storage volume information.
" - }, - "NoDevice":{ - "shape":"NoDevice", - "documentation":"Suppresses the device mapping.
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. The BlockDeviceMapping data type.
The output of the CompleteLifecycleAction.
" - }, - "CompleteLifecycleActionType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName", - "LifecycleActionToken", - "LifecycleActionResult" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which the lifecycle hook belongs.
" - }, - "LifecycleActionToken":{ - "shape":"LifecycleActionToken", - "documentation":"A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
" - }, - "LifecycleActionResult":{ - "shape":"LifecycleActionResult", - "documentation":"The action the Auto Scaling group should take. The value for this parameter can be either CONTINUE or ABANDON.
The name of the Auto Scaling group.
" - }, - "LaunchConfigurationName":{ - "shape":"ResourceName", - "documentation":"The name of an existing launch configuration to use to launch new instances. Use this attribute if you want to create an Auto Scaling group using an existing launch configuration instead of an EC2 instance.
" - }, - "InstanceId":{ - "shape":"XmlStringMaxLen16", - "documentation":"The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this attribute if you want to create an Auto Scaling group using an EC2 instance instead of a launch configuration.
When you use an instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its attributes from the instance that is used to create the Auto Scaling group, with the exception of BlockDeviceMapping.
For more information, see Create an Auto Scaling Group Using EC2 Instance in the Auto Scaling Developer Guide.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"The minimum size of the Auto Scaling group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of Amazon EC2 instances that should be running in the group. The desired capacity must be greater than or equal to the minimum size and less than or equal to the maximum size specified for the Auto Scaling group.
" - }, - "DefaultCooldown":{ - "shape":"Cooldown", - "documentation":"The amount of time, in seconds, between a successful scaling activity and the succeeding scaling activity.
If a DefaultCooldown period is not specified, Auto Scaling uses the default value of 300 as the default cool down period for the Auto Scaling group. For more information, see Cooldown Period
A list of Availability Zones for the Auto Scaling group. This is required unless you have specified subnets.
" - }, - "LoadBalancerNames":{ - "shape":"LoadBalancerNames", - "documentation":"A list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account.
For information on using load balancers, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "HealthCheckType":{ - "shape":"XmlStringMaxLen32", - "documentation":"The service you want the health checks from, Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
" - }, - "HealthCheckGracePeriod":{ - "shape":"HealthCheckGracePeriod", - "documentation":"Length of time in seconds after a new Amazon EC2 instance comes into service that Auto Scaling starts checking its health. During this time any health check failure for the that instance is ignored.
This is required if you are adding ELB health check. Frequently, new instances need to warm up, briefly, before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to match the expected startup period of your application.
For more information, see Add an Elastic Load Balancing Health Check.
" - }, - "PlacementGroup":{ - "shape":"XmlStringMaxLen255", - "documentation":"Physical location of an existing cluster placement group into which you want to launch your instances. For information about cluster placement group, see Using Cluster Instances
" - }, - "VPCZoneIdentifier":{ - "shape":"XmlStringMaxLen255", - "documentation":"A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide .
" - }, - "TerminationPolicies":{ - "shape":"TerminationPolicies", - "documentation":"A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
" - }, - "Tags":{ - "shape":"Tags", - "documentation":"The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling Developer Guide.
" - } - }, - "documentation":"" - }, - "CreateLaunchConfigurationType":{ - "type":"structure", - "required":["LaunchConfigurationName"], - "members":{ - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"
The name of the launch configuration to create.
" - }, - "ImageId":{ - "shape":"XmlStringMaxLen255", - "documentation":"Unique ID of the Amazon Machine Image (AMI) you want to use to launch your EC2 instances. For information about finding Amazon EC2 AMIs, see Finding a Suitable AMI in the Amazon Elastic Compute Cloud User Guide.
" - }, - "KeyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Amazon EC2 key pair. For more information, see Getting a Key Pair in the Amazon Elastic Compute Cloud User Guide.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"The security groups with which to associate Amazon EC2 or Amazon VPC instances.
If your instances are launched in EC2, you can either specify Amazon EC2 security group names or the security group IDs. For more information about Amazon EC2 security groups, see Using Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched within VPC, specify Amazon VPC security group IDs. For more information about Amazon VPC security groups, see Security Groups in the Amazon Virtual Private Cloud User Guide.
" - }, - "UserData":{ - "shape":"XmlStringUserData", - "documentation":"The user data to make available to the launched Amazon EC2 instances. For more information about Amazon EC2 user data, see User Data Retrieval in the Amazon Elastic Compute Cloud User Guide.
The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this attribute if you want the launch configuration to derive its attributes from an EC2 instance.
When you use an instance to create a launch configuration, all you need to specify is the InstanceId. The new launch configuration, by default, derives all the attributes from the specified instance with the exception of BlockDeviceMapping.
If you want to create a launch configuration with BlockDeviceMapping or override any other instance attributes, specify them as part of the same request.
For more information on using an InstanceID to create a launch configuration, see Create a Launch Configuration Using an Amazon EC2 Instance in the Auto Scaling Developer Guide.
" - }, - "InstanceType":{ - "shape":"XmlStringMaxLen255", - "documentation":"The instance type of the Amazon EC2 instance. For information about available Amazon EC2 instance types, see Available Instance Types in the Amazon Elastic Cloud Compute User Guide.
" - }, - "KernelId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the kernel associated with the Amazon EC2 AMI.
" - }, - "RamdiskId":{ - "shape":"XmlStringMaxLen255", - "documentation":"The ID of the RAM disk associated with the Amazon EC2 AMI.
" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappings", - "documentation":"A list of mappings that specify how block devices are exposed to the instance. Each mapping is made up of a VirtualName, a DeviceName, and an ebs data structure that contains information about the associated Elastic Block Storage volume. For more information about Amazon EC2 BlockDeviceMappings, go to Block Device Mapping in the Amazon EC2 product documentation.
" - }, - "InstanceMonitoring":{ - "shape":"InstanceMonitoring", - "documentation":"Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.
When detailed monitoring is enabled, Amazon Cloudwatch will generate metrics every minute and your account will be charged a fee. When you disable detailed monitoring, by specifying False, Cloudwatch will generate metrics every 5 minutes. For more information, see Monitor Your Auto Scaling Instances. For information about Amazon CloudWatch, see the Amazon CloudWatch Developer Guide.
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information on launching Spot Instances, see Using Auto Scaling to Launch Spot Instances in the Auto Scaling Developer Guide.
" - }, - "IamInstanceProfile":{ - "shape":"XmlStringMaxLen1600", - "documentation":"The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role in the Auto Scaling Developer Guide.
" - }, - "EbsOptimized":{ - "shape":"EbsOptimized", - "documentation":"Whether the instance is optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization is not available with all instance types. Additional usage charges apply when using an EBS Optimized instance. By default the instance is not optimized for EBS I/O. For information about EBS-optimized instances, go to EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.
" - }, - "AssociatePublicIpAddress":{ - "shape":"AssociatePublicIpAddress", - "documentation":"Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. For more information, see Auto Scaling in Amazon Virtual Private Cloud.
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
Default: If the instance is launched into a default subnet in a default VPC, the default is true. If the instance is launched into a nondefault subnet in a VPC, the default is false. For information about default VPC and VPC platforms, see Supported Platforms.
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched in a VPC.
You must set the value of this parameter to dedicated if want to launch Dedicated Instances in a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Valid values: default | dedicated
" - }, - "CreateOrUpdateTagsType":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"Tags", - "documentation":"
The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. The resource type and resource ID identify the type and name of resource for which the tag is created. Currently, auto-scaling-group is the only supported resource type. The valid value for the resource ID is groupname.
The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by the Auto Scaling group. Valid values are true or false. However, instances that are already running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be applied only to new instances launched by the Auto Scaling group after the change. Running instances that had the previous version of the tag will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
" - } - }, - "documentation":"" - }, - "DeleteAutoScalingGroupType":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"
The name of the Auto Scaling group to delete.
" - }, - "ForceDelete":{ - "shape":"ForceDelete", - "documentation":"Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
" - } - }, - "documentation":"" - }, - "DeleteLifecycleHookAnswer":{ - "type":"structure", - "members":{ - }, - "documentation":"
The output of the DeleteLifecycleHook action.
" - }, - "DeleteLifecycleHookType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which the lifecycle hook belongs.
" - } - } - }, - "DeleteNotificationConfigurationType":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "TopicARN" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "TopicARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
" - } - }, - "documentation":"" - }, - "DeletePolicyType":{ - "type":"structure", - "required":["PolicyName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "PolicyName":{ - "shape":"ResourceName", - "documentation":"The name or PolicyARN of the policy you want to delete.
" - } - }, - "documentation":"" - }, - "DeleteScheduledActionType":{ - "type":"structure", - "required":["ScheduledActionName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "ScheduledActionName":{ - "shape":"ResourceName", - "documentation":"The name of the action you want to delete.
" - } - }, - "documentation":"" - }, - "DeleteTagsType":{ - "type":"structure", - "required":["Tags"], - "members":{ - "Tags":{ - "shape":"Tags", - "documentation":"Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, key=value, value=value, propagate=true or false.
" - } - }, - "documentation":"" - }, - "DescribeAccountLimitsAnswer":{ - "type":"structure", - "members":{ - "MaxNumberOfAutoScalingGroups":{ - "shape":"MaxNumberOfAutoScalingGroups", - "documentation":"
The maximum number of Auto Scaling groups allowed for your AWS account.
" - }, - "MaxNumberOfLaunchConfigurations":{ - "shape":"MaxNumberOfLaunchConfigurations", - "documentation":"The maximum number of launch configurations allowed for your AWS account.
" - } - }, - "documentation":"The output of the DescribeAccountLimitsResult action.
" - }, - "DescribeAdjustmentTypesAnswer":{ - "type":"structure", - "members":{ - "AdjustmentTypes":{ - "shape":"AdjustmentTypes", - "documentation":"A list of specific policy adjustment types.
" - } - }, - "documentation":"The output of the DescribeAdjustmentTypes action.
" - }, - "DescribeAutoScalingInstancesType":{ - "type":"structure", - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of Auto Scaling instances to be described with each call.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"The token returned by a previous call to indicate that there is more data available.
" - } - } - }, - "DescribeAutoScalingNotificationTypesAnswer":{ - "type":"structure", - "members":{ - "AutoScalingNotificationTypes":{ - "shape":"AutoScalingNotificationTypes", - "documentation":"Returns a list of all notification types supported by Auto Scaling. They are:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
The AutoScalingNotificationTypes data type.
Returns a list of all notification types supported by Auto Scaling. They are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
A list describing the lifecycle hooks that belong to the specified Auto Scaling group.
" - } - }, - "documentation":"The output of the DescribeLifecycleHooks action.
" - }, - "DescribeLifecycleHooksType":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of one or more Auto Scaling groups.
" - }, - "LifecycleHookNames":{ - "shape":"LifecycleHookNames", - "documentation":"The name of one or more lifecycle hooks.
" - } - } - }, - "DescribeMetricCollectionTypesAnswer":{ - "type":"structure", - "members":{ - "Metrics":{ - "shape":"MetricCollectionTypes", - "documentation":"The list of Metrics collected. The following metrics are supported:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
A list of granularities for the listed Metrics.
" - } - }, - "documentation":"The output of the DescribeMetricCollectionTypes action.
" - }, - "DescribeNotificationConfigurationsAnswer":{ - "type":"structure", - "required":["NotificationConfigurations"], - "members":{ - "NotificationConfigurations":{ - "shape":"NotificationConfigurations", - "documentation":"The list of notification configurations.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that is used to mark the start of the next batch of returned results for pagination.
" - } - }, - "documentation":"The output of the DescribeNotificationConfigurations action.
" - }, - "DescribeNotificationConfigurationsType":{ - "type":"structure", - "members":{ - "AutoScalingGroupNames":{ - "shape":"AutoScalingGroupNames", - "documentation":"The name of the Auto Scaling group.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that is used to mark the start of the next batch of returned results for pagination.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"Maximum number of records to be returned.
" - } - } - }, - "DescribePoliciesType":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "PolicyNames":{ - "shape":"PolicyNames", - "documentation":"A list of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group name is provided, the results are limited to that group. The list of requested policy names cannot contain more than 50 items. If unknown policy names are requested, they are ignored with no error.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that is used to mark the start of the next batch of returned results for pagination.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of policies that will be described with each call.
" - } - } - }, - "DescribeScalingActivitiesType":{ - "type":"structure", - "members":{ - "ActivityIds":{ - "shape":"ActivityIds", - "documentation":" A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.
The name of the AutoScalingGroup.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of scaling activities to return.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results for pagination.
" - } - }, - "documentation":"" - }, - "DescribeScheduledActionsType":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"
The name of the Auto Scaling group.
" - }, - "ScheduledActionNames":{ - "shape":"ScheduledActionNames", - "documentation":"A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.
" - }, - "StartTime":{ - "shape":"TimestampType", - "documentation":"The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.
" - }, - "EndTime":{ - "shape":"TimestampType", - "documentation":"The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of scheduled actions to return.
" - } - } - }, - "DescribeTagsType":{ - "type":"structure", - "members":{ - "Filters":{ - "shape":"Filters", - "documentation":"The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of records to return.
" - } - }, - "documentation":"" - }, - "DescribeTerminationPolicyTypesAnswer":{ - "type":"structure", - "members":{ - "TerminationPolicyTypes":{ - "shape":"TerminationPolicies", - "documentation":"
Termination policies supported by Auto Scaling. They are: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default
The TerminationPolicyTypes data type.
A list describing the activities related to detaching the instances from the Auto Scaling group.
" - } - }, - "documentation":"The output of the DetachInstances action.
" - }, - "DetachInstancesQuery":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "ShouldDecrementDesiredCapacity" - ], - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group from which to detach instances.
" - }, - "ShouldDecrementDesiredCapacity":{ - "shape":"ShouldDecrementDesiredCapacity", - "documentation":" Specifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
The name or ARN of the Auto Scaling Group.
" - }, - "Metrics":{ - "shape":"Metrics", - "documentation":"The list of metrics to disable. If no metrics are specified, all metrics are disabled. The following metrics are supported:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The snapshot ID.
" - }, - "VolumeSize":{ - "shape":"BlockDeviceEbsVolumeSize", - "documentation":"The volume size, in gigabytes.
Valid values: If the volume type is io1, the minimum size of the volume is 10.
Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size.
Required: Required when the volume type is io1.
The volume type.
Valid values: standard | io1
Default: standard
Indicates whether to delete the volume on instance termination.
Default: true
The number of I/O operations per second (IOPS) that the volume supports.
The maximum ratio of IOPS to volume size is 30.0
Valid Values: Range is 100 to 4000.
Default: None.
" - } - }, - "documentation":"The Ebs data type.
" - }, - "EbsOptimized":{"type":"boolean"}, - "EnableMetricsCollectionQuery":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "Granularity" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name or ARN of the Auto Scaling group.
" - }, - "Metrics":{ - "shape":"Metrics", - "documentation":"The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:
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 granularity to associate with the metrics to collect. Currently, the only legal granularity is \"1Minute\".
" - } - } - }, - "EnabledMetric":{ - "type":"structure", - "members":{ - "Metric":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the enabled metric.
" - }, - "Granularity":{ - "shape":"XmlStringMaxLen255", - "documentation":"The granularity of the enabled metric.
" - } - }, - "documentation":" The EnabledMetric data type.
A list describing the activities related to moving instances into Standby mode.
" - } - }, - "documentation":"The output of the EnterStandby action.
" - }, - "EnterStandbyQuery":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "ShouldDecrementDesiredCapacity" - ], - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"The instances to move into Standby mode. You must specify at least one instance ID.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group from which to move instances into Standby mode.
" - }, - "ShouldDecrementDesiredCapacity":{ - "shape":"ShouldDecrementDesiredCapacity", - "documentation":"Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.
" - } - } - }, - "ExecutePolicyType":{ - "type":"structure", - "required":["PolicyName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name or the Amazon Resource Name (ARN) of the Auto Scaling group.
" - }, - "PolicyName":{ - "shape":"ResourceName", - "documentation":"The name or ARN of the policy you want to run.
" - }, - "HonorCooldown":{ - "shape":"HonorCooldown", - "documentation":"Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy.
Set to False if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends.
For information about cooldown period, see Cooldown Period in the Auto Scaling Developer Guide.
" - } - } - }, - "ExitStandbyAnswer":{ - "type":"structure", - "members":{ - "Activities":{ - "shape":"Activities", - "documentation":"A list describing the activities related to moving instances out of Standby mode.
" - } - }, - "documentation":"The output of the ExitStandby action.
" - }, - "ExitStandbyQuery":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "InstanceIds":{ - "shape":"InstanceIds", - "documentation":"A list of instances to move out of Standby mode. You must specify at least one instance ID.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group from which to move instances out of Standby mode.
" - } - } - }, - "Filter":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"XmlString", - "documentation":" The name of the filter. Valid Name values are: \"auto-scaling-group\", \"key\", \"value\", and \"propagate-at-launch\".
The value of the filter.
" - } - }, - "documentation":"The Filter data type.
Specifies the ID of the Amazon EC2 instance.
" - }, - "AvailabilityZone":{ - "shape":"XmlStringMaxLen255", - "documentation":"Availability Zones associated with this instance.
" - }, - "LifecycleState":{ - "shape":"LifecycleState", - "documentation":"Contains a description of the current lifecycle state.
The Quarantined lifecycle state is currently not used.
The instance's health status.
" - }, - "LaunchConfigurationName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The launch configuration associated with this instance.
" - } - }, - "documentation":" The Instance data type.
If True, instance monitoring is enabled.
The InstanceMonitoring data type.
" - } - }, - "error":{ - "code":"InvalidNextToken", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The NextToken value is invalid.
Specifies the name of the launch configuration.
" - }, - "LaunchConfigurationARN":{ - "shape":"ResourceName", - "documentation":"The launch configuration's Amazon Resource Name (ARN).
" - }, - "ImageId":{ - "shape":"XmlStringMaxLen255", - "documentation":"Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
" - }, - "KeyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"Provides the name of the Amazon EC2 key pair.
" - }, - "SecurityGroups":{ - "shape":"SecurityGroups", - "documentation":"A description of the security groups to associate with the Amazon EC2 instances.
" - }, - "UserData":{ - "shape":"XmlStringUserData", - "documentation":"The user data available to the launched Amazon EC2 instances.
" - }, - "InstanceType":{ - "shape":"XmlStringMaxLen255", - "documentation":"Specifies the instance type of the Amazon EC2 instance.
" - }, - "KernelId":{ - "shape":"XmlStringMaxLen255", - "documentation":"Provides the ID of the kernel associated with the Amazon EC2 AMI.
" - }, - "RamdiskId":{ - "shape":"XmlStringMaxLen255", - "documentation":"Provides ID of the RAM disk associated with the Amazon EC2 AMI.
" - }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappings", - "documentation":"Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.
" - }, - "InstanceMonitoring":{ - "shape":"InstanceMonitoring", - "documentation":"Controls whether instances in this group are launched with detailed monitoring or not.
" - }, - "SpotPrice":{ - "shape":"SpotPrice", - "documentation":"Specifies the price to bid when launching Spot Instances.
" - }, - "IamInstanceProfile":{ - "shape":"XmlStringMaxLen1600", - "documentation":"Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
" - }, - "CreatedTime":{ - "shape":"TimestampType", - "documentation":"Provides the creation date and time for this launch configuration.
" - }, - "EbsOptimized":{ - "shape":"EbsOptimized", - "documentation":"Specifies whether the instance is optimized for EBS I/O (true) or not (false).
" - }, - "AssociatePublicIpAddress":{ - "shape":"AssociatePublicIpAddress", - "documentation":"Specifies whether the instance is associated with a public IP address (true) or not (false).
Specifies the tenancy of the instance. It can be either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and it can only be launched in a VPC.
The LaunchConfiguration data type.
The name of the launch configuration.
" - } - }, - "documentation":"" - }, - "LaunchConfigurationNames":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "LaunchConfigurationNamesType":{ - "type":"structure", - "members":{ - "LaunchConfigurationNames":{ - "shape":"LaunchConfigurationNames", - "documentation":"
A list of launch configuration names.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - }, - "MaxRecords":{ - "shape":"MaxRecords", - "documentation":"The maximum number of launch configurations. The default is 100.
" - } - }, - "documentation":" The LaunchConfigurationNamesType data type.
A list of launch configurations.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":" The LaunchConfigurationsType data type.
The name of the lifecycle action hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which the lifecycle action belongs.
" - }, - "LifecycleTransition":{ - "shape":"LifecycleTransition", - "documentation":"The Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHooks for a list of available lifecycle hook types.
" - }, - "NotificationTargetARN":{ - "shape":"ResourceName", - "documentation":"The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target will include:
The ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.
" - }, - "NotificationMetadata":{ - "shape":"XmlStringMaxLen1023", - "documentation":"Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
" - }, - "HeartbeatTimeout":{ - "shape":"HeartbeatTimeout", - "documentation":"Defines the amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
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 value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is CONTINUE.
A lifecycle hook tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:
To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State.
" - }, - "LifecycleHookNames":{ - "type":"list", - "member":{"shape":"AsciiStringMaxLen255"} - }, - "LifecycleHooks":{ - "type":"list", - "member":{"shape":"LifecycleHook"} - }, - "LifecycleState":{ - "type":"string", - "enum":[ - "Pending", - "Pending:Wait", - "Pending:Proceed", - "Quarantined", - "InService", - "Terminating", - "Terminating:Wait", - "Terminating:Proceed", - "Terminated", - "Detaching", - "Detached", - "EnteringStandby", - "Standby" - ] - }, - "LifecycleTransition":{"type":"string"}, - "LimitExceededFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"XmlStringMaxLen255", - "documentation":"" - } - }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
The quota for capacity groups or launch configurations for this customer has already been reached.
" - }, - "LoadBalancerNames":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "MaxNumberOfAutoScalingGroups":{"type":"integer"}, - "MaxNumberOfLaunchConfigurations":{"type":"integer"}, - "MaxRecords":{"type":"integer"}, - "MetricCollectionType":{ - "type":"structure", - "members":{ - "Metric":{"shape":"XmlStringMaxLen255"} - }, - "documentation":"The MetricCollectionType data type.
" - }, - "MetricCollectionTypes":{ - "type":"list", - "member":{"shape":"MetricCollectionType"} - }, - "MetricGranularityType":{ - "type":"structure", - "members":{ - "Granularity":{ - "shape":"XmlStringMaxLen255", - "documentation":"The granularity of a Metric.
" - } - }, - "documentation":"The MetricGranularityType data type.
" - }, - "MetricGranularityTypes":{ - "type":"list", - "member":{"shape":"MetricGranularityType"} - }, - "Metrics":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen255"} - }, - "MinAdjustmentStep":{"type":"integer"}, - "MonitoringEnabled":{"type":"boolean"}, - "NoDevice":{"type":"boolean"}, - "NotificationConfiguration":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"Specifies the Auto Scaling group name.
" - }, - "TopicARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
" - }, - "NotificationType":{ - "shape":"XmlStringMaxLen255", - "documentation":"The types of events for an action to start.
" - } - }, - "documentation":" The NotificationConfiguration data type.
A list of scaling policies.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":" The PoliciesType data type.
A policy's Amazon Resource Name (ARN).
" - } - }, - "documentation":" The PolicyARNType data type.
The name of a process.
" - } - }, - "documentation":" There are two primary Auto Scaling process types--Launch and Terminate. The Launch process creates a new Amazon EC2 instance for an Auto Scaling group, and the Terminate process removes an existing Amazon EC2 instance.
The remaining Auto Scaling process types relate to specific Auto Scaling features:
If you suspend Launch or Terminate, all other process types are affected to varying degrees. The following descriptions discuss how each process type is affected by a suspension of Launch or Terminate.
The AddToLoadBalancer process type adds instances to the load balancer when the instances are launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to the load balancer. If you resume the AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load balancer when they are launched. However, Auto Scaling will not add running instances that were launched while the process was suspended; those instances must be added manually using the the RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference.
The AlarmNotification process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the AlarmNotification process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms.
Although the AlarmNotification process type is not directly affected by a suspension of Launch or Terminate, alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend Launch or Terminate, Auto Scaling might not be able to implement the alarm's associated policy.
The AZRebalance process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated Availability Zones.
If you call SuspendProcesses on the launch process type, the AZRebalance process will neither launch new instances nor terminate existing instances. This is because the AZRebalance process terminates existing instances only after launching the replacement instances.
If you call SuspendProcesses on the terminate process type, the AZRebalance process can cause your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could remain up to ten percent larger than the maximum size until you resume the terminate process type.
The HealthCheck process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy. The HealthCheck process can override the health status of an instance that you set with SetInstanceHealth.
The ReplaceUnhealthy process type terminates instances that are marked as unhealthy and subsequently creates new instances to replace them. This process calls both of the primary process types--first Terminate and then Launch.
The HealthCheck process type works in conjunction with the ReplaceUnhealthly process type to provide health check functionality. If you suspend either Launch or Terminate, the ReplaceUnhealthy process type will not function properly.
The ScheduledActions process type performs scheduled actions that you create with PutScheduledUpdateGroupAction. Scheduled actions often involve launching new instances or terminating existing instances. If you suspend either Launch or Terminate, your scheduled actions might not function as expected.
A list of ProcessType names.
" - } - }, - "documentation":"The output of the DescribeScalingProcessTypes action.
" - }, - "Progress":{"type":"integer"}, - "PropagateAtLaunch":{"type":"boolean"}, - "PutLifecycleHookAnswer":{ - "type":"structure", - "members":{ - }, - "documentation":"The output of the PutLifecycleHook action.
" - }, - "PutLifecycleHookType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which you want to assign the lifecycle hook.
" - }, - "LifecycleTransition":{ - "shape":"LifecycleTransition", - "documentation":"The Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHookTypes for a list of available lifecycle hook types.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The ARN of the Amazon 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 Auto Scaling group.
" - }, - "PolicyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the policy you want to create or update.
" - }, - "ScalingAdjustment":{ - "shape":"PolicyIncrement", - "documentation":" The number of instances by which to scale. AdjustmentType determines the interpretation of this number (e.g., as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity.
Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
For more information about the adjustment types supported by Auto Scaling, see Scale Based on Demand.
" - }, - "Cooldown":{ - "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
For more information, see Cooldown Period
" - }, - "MinAdjustmentStep":{ - "shape":"MinAdjustmentStep", - "documentation":" Used with AdjustmentType with the value PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.
You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType other than PercentChangeInCapacity.
The name or ARN of the Auto Scaling group.
" - }, - "ScheduledActionName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of this scaling action.
" - }, - "Time":{ - "shape":"TimestampType", - "documentation":"Time is deprecated.
The time for this action to start. Time is an alias for StartTime and can be specified instead of StartTime, or vice versa. If both Time and StartTime are specified, their values should be identical. Otherwise, PutScheduledUpdateGroupAction will return an error.
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":{ - }, - "documentation":"The output of the RecordLifecycleActionHeartbeat action.
" - }, - "RecordLifecycleActionHeartbeatType":{ - "type":"structure", - "required":[ - "LifecycleHookName", - "AutoScalingGroupName", - "LifecycleActionToken" - ], - "members":{ - "LifecycleHookName":{ - "shape":"AsciiStringMaxLen255", - "documentation":"The name of the lifecycle hook.
" - }, - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group to which the hook belongs.
" - }, - "LifecycleActionToken":{ - "shape":"LifecycleActionToken", - "documentation":"A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
" - } - } - }, - "ResourceInUseFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"XmlStringMaxLen255", - "documentation":"" - } - }, - "error":{ - "code":"ResourceInUse", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used.
" - }, - "ResourceName":{ - "type":"string", - "min":1, - "max":1600, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "ScalingActivityInProgressFault":{ - "type":"structure", - "members":{ - "message":{ - "shape":"XmlStringMaxLen255", - "documentation":"" - } - }, - "error":{ - "code":"ScalingActivityInProgress", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"
You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
" - }, - "ScalingActivityStatusCode":{ - "type":"string", - "enum":[ - "WaitingForSpotInstanceRequestId", - "WaitingForSpotInstanceId", - "WaitingForInstanceId", - "PreInService", - "InProgress", - "WaitingForELBConnectionDraining", - "MidLifecycleAction", - "Successful", - "Failed", - "Cancelled" - ] - }, - "ScalingPolicies":{ - "type":"list", - "member":{"shape":"ScalingPolicy"} - }, - "ScalingPolicy":{ - "type":"structure", - "members":{ - "AutoScalingGroupName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the Auto Scaling group associated with this scaling policy.
" - }, - "PolicyName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the scaling policy.
" - }, - "ScalingAdjustment":{ - "shape":"PolicyIncrement", - "documentation":"The number associated with the specified adjustment type. A positive value adds to the current capacity and a negative value removes from the current capacity.
" - }, - "AdjustmentType":{ - "shape":"XmlStringMaxLen255", - "documentation":" Specifies whether the ScalingAdjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
" - }, - "PolicyARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of the policy.
" - }, - "Alarms":{ - "shape":"Alarms", - "documentation":"A list of CloudWatch Alarms related to the policy.
" - }, - "MinAdjustmentStep":{ - "shape":"MinAdjustmentStep", - "documentation":" Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.
The ScalingPolicy data type.
The name or Amazon Resource Name (ARN) of the Auto Scaling group.
" - }, - "ScalingProcesses":{ - "shape":"ProcessNames", - "documentation":"The processes that you want to suspend or resume, which can include one or more of the following:
To suspend all process types, omit this parameter.
" - } - } - }, - "ScheduledActionNames":{ - "type":"list", - "member":{"shape":"ResourceName"} - }, - "ScheduledActionsType":{ - "type":"structure", - "members":{ - "ScheduledUpdateGroupActions":{ - "shape":"ScheduledUpdateGroupActions", - "documentation":"A list of scheduled actions designed to update an Auto Scaling group.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string that marks the start of the next batch of returned results.
" - } - }, - "documentation":"A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance.
Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occurs regularly on a schedule.
The name of the Auto Scaling group to be updated.
" - }, - "ScheduledActionName":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of this scheduled action.
" - }, - "ScheduledActionARN":{ - "shape":"ResourceName", - "documentation":"The Amazon Resource Name (ARN) of this scheduled action.
" - }, - "Time":{ - "shape":"TimestampType", - "documentation":" Time is deprecated.
The time that the action is scheduled to begin. Time is an alias for StartTime.
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 Auto Scaling group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The number of instances you prefer to maintain in your Auto Scaling group.
" - } - }, - "documentation":"This data type stores information about a scheduled update to an Auto Scaling group.
" - }, - "ScheduledUpdateGroupActions":{ - "type":"list", - "member":{"shape":"ScheduledUpdateGroupAction"} - }, - "SecurityGroups":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "SetDesiredCapacityType":{ - "type":"structure", - "required":[ - "AutoScalingGroupName", - "DesiredCapacity" - ], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"The name of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The new capacity setting for the Auto Scaling group.
" - }, - "HonorCooldown":{ - "shape":"HonorCooldown", - "documentation":" By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Set to True if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to the new capacity setting.
" - }, - "SetInstanceHealthQuery":{ - "type":"structure", - "required":[ - "InstanceId", - "HealthStatus" - ], - "members":{ - "InstanceId":{ - "shape":"XmlStringMaxLen16", - "documentation":"
The identifier of the Amazon EC2 instance.
" - }, - "HealthStatus":{ - "shape":"XmlStringMaxLen32", - "documentation":" The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.
For more information, see the HealthCheckGracePeriod parameter description in the CreateAutoScalingGroup action.
The name of the suspended process.
" - }, - "SuspensionReason":{ - "shape":"XmlStringMaxLen255", - "documentation":"The reason that the process was suspended.
" - } - }, - "documentation":"An Auto Scaling process that has been suspended. For more information, see ProcessType.
" - }, - "SuspendedProcesses":{ - "type":"list", - "member":{"shape":"SuspendedProcess"} - }, - "Tag":{ - "type":"structure", - "required":["Key"], - "members":{ - "ResourceId":{ - "shape":"XmlString", - "documentation":"The name of the Auto Scaling group.
" - }, - "ResourceType":{ - "shape":"XmlString", - "documentation":" The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.
The key of the tag.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The value of the tag.
" - }, - "PropagateAtLaunch":{ - "shape":"PropagateAtLaunch", - "documentation":"Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.
" - } - }, - "documentation":"The tag applied to an Auto Scaling group.
" - }, - "TagDescription":{ - "type":"structure", - "members":{ - "ResourceId":{ - "shape":"XmlString", - "documentation":"The name of the Auto Scaling group.
" - }, - "ResourceType":{ - "shape":"XmlString", - "documentation":" The kind of resource to which the tag is applied. Currently, Auto Scaling supports the auto-scaling-group resource type.
The key of the tag.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The value of the tag.
" - }, - "PropagateAtLaunch":{ - "shape":"PropagateAtLaunch", - "documentation":"Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change.
" - } - }, - "documentation":"The tag applied to an Auto Scaling group.
" - }, - "TagDescriptionList":{ - "type":"list", - "member":{"shape":"TagDescription"} - }, - "TagKey":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "TagValue":{ - "type":"string", - "min":0, - "max":256, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "Tags":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "TagsType":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagDescriptionList", - "documentation":"The list of tags.
" - }, - "NextToken":{ - "shape":"XmlString", - "documentation":"A string used to mark the start of the next batch of returned results.
" - } - }, - "documentation":"" - }, - "TerminateInstanceInAutoScalingGroupType":{ - "type":"structure", - "required":[ - "InstanceId", - "ShouldDecrementDesiredCapacity" - ], - "members":{ - "InstanceId":{ - "shape":"XmlStringMaxLen16", - "documentation":"
The ID of the Amazon EC2 instance to be terminated.
" - }, - "ShouldDecrementDesiredCapacity":{ - "shape":"ShouldDecrementDesiredCapacity", - "documentation":"Specifies whether (true) or not (false) terminating this instance should also decrement the size of the AutoScalingGroup.
" - } - }, - "documentation":"" - }, - "TerminationPolicies":{ - "type":"list", - "member":{"shape":"XmlStringMaxLen1600"} - }, - "TimestampType":{"type":"timestamp"}, - "UpdateAutoScalingGroupType":{ - "type":"structure", - "required":["AutoScalingGroupName"], - "members":{ - "AutoScalingGroupName":{ - "shape":"ResourceName", - "documentation":"
The name of the Auto Scaling group.
" - }, - "LaunchConfigurationName":{ - "shape":"ResourceName", - "documentation":"The name of the launch configuration.
" - }, - "MinSize":{ - "shape":"AutoScalingGroupMinSize", - "documentation":"The minimum size of the Auto Scaling group.
" - }, - "MaxSize":{ - "shape":"AutoScalingGroupMaxSize", - "documentation":"The maximum size of the Auto Scaling group.
" - }, - "DesiredCapacity":{ - "shape":"AutoScalingGroupDesiredCapacity", - "documentation":"The desired capacity for the Auto Scaling group.
" - }, - "DefaultCooldown":{ - "shape":"Cooldown", - "documentation":"The amount of time, in seconds, after a scaling activity completes before any further scaling activities can start. For more information, see Cooldown Period.
" - }, - "AvailabilityZones":{ - "shape":"AvailabilityZones", - "documentation":"Availability Zones for the group.
" - }, - "HealthCheckType":{ - "shape":"XmlStringMaxLen32", - "documentation":" The type of health check for the instances in the Auto Scaling group. The health check type can either be EC2 for Amazon EC2 or ELB for Elastic Load Balancing.
The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when the instance passes System Status and the Instance Status checks from Amazon EC2. For more information, see DescribeInstanceStatus.
" - }, - "PlacementGroup":{ - "shape":"XmlStringMaxLen255", - "documentation":"The name of the cluster placement group, if applicable. For more information, go to Using Cluster Instances in the Amazon EC2 User Guide.
" - }, - "VPCZoneIdentifier":{ - "shape":"XmlStringMaxLen255", - "documentation":"The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list.
When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.
For more information on creating your Auto Scaling group in Amazon VPC by specifying subnets, see Launch Auto Scaling Instances into Amazon VPC in the the Auto Scaling Developer Guide.
" - }, - "TerminationPolicies":{ - "shape":"TerminationPolicies", - "documentation":"A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information on creating a termination policy for your Auto Scaling group, go to Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
" - } - }, - "documentation":"" - }, - "Values":{ - "type":"list", - "member":{"shape":"XmlString"} - }, - "XmlString":{ - "type":"string", - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen1023":{ - "type":"string", - "min":1, - "max":1023, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen16":{ - "type":"string", - "min":1, - "max":16, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen1600":{ - "type":"string", - "min":1, - "max":1600, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen255":{ - "type":"string", - "min":1, - "max":255, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen32":{ - "type":"string", - "min":1, - "max":32, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringMaxLen64":{ - "type":"string", - "min":1, - "max":64, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - }, - "XmlStringUserData":{ - "type":"string", - "max":21847, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - } - } -} diff --git a/Frameworks/AWSCloudWatch.framework/AWSCloudWatch b/Frameworks/AWSCloudWatch.framework/AWSCloudWatch deleted file mode 100755 index dfca4ea..0000000 Binary files a/Frameworks/AWSCloudWatch.framework/AWSCloudWatch and /dev/null differ diff --git a/Frameworks/AWSCloudWatch.framework/Headers/AWSCloudWatch-umbrella.h b/Frameworks/AWSCloudWatch.framework/Headers/AWSCloudWatch-umbrella.h deleted file mode 100644 index eaaa177..0000000 --- a/Frameworks/AWSCloudWatch.framework/Headers/AWSCloudWatch-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#import
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 descriptive name for the alarm.
- */ -@property (nonatomic, strong) NSString *alarmName; - -/** -Machine-readable data about the alarm in JSON format.
- */ -@property (nonatomic, strong) NSString *historyData; - -/** -The type of alarm history item.
- */ -@property (nonatomic, assign) AWSCloudWatchHistoryItemType historyItemType; - -/** -A human-readable summary of the alarm history.
- */ -@property (nonatomic, strong) NSString *historySummary; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -@end - -/** - The Datapoint data type encapsulates the statistical data that Amazon CloudWatch computes from metric data.
The average of metric values that correspond to the datapoint.
- */ -@property (nonatomic, strong) NSNumber *average; - -/** -The maximum of the metric value used for the datapoint.
- */ -@property (nonatomic, strong) NSNumber *maximum; - -/** -The minimum metric value used for the datapoint.
- */ -@property (nonatomic, strong) NSNumber *minimum; - -/** -The number of metric values that contributed to the aggregate value of this datapoint.
- */ -@property (nonatomic, strong) NSNumber *sampleCount; - -/** -The sum of metric values used for the datapoint.
- */ -@property (nonatomic, strong) NSNumber *sum; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -/** -The standard unit used for the datapoint.
- */ -@property (nonatomic, assign) AWSCloudWatchStandardUnit unit; - -@end - -/** - - */ -@interface AWSCloudWatchDeleteAlarmsInput : AWSRequest - - -/** -A list of alarms to be deleted.
- */ -@property (nonatomic, strong) NSArray *alarmNames; - -@end - -/** - - */ -@interface AWSCloudWatchDescribeAlarmHistoryInput : AWSRequest - - -/** -The name of the alarm.
- */ -@property (nonatomic, strong) NSString *alarmName; - -/** -The ending date to retrieve alarm history.
- */ -@property (nonatomic, strong) NSDate *endDate; - -/** -The type of alarm histories to retrieve.
- */ -@property (nonatomic, assign) AWSCloudWatchHistoryItemType historyItemType; - -/** -The maximum number of alarm history records to retrieve.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -The token returned by a previous call to indicate that there is more data available.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -The starting date to retrieve alarm history.
- */ -@property (nonatomic, strong) NSDate *startDate; - -@end - -/** -The output for the DescribeAlarmHistory action.
- */ -@interface AWSCloudWatchDescribeAlarmHistoryOutput : AWSModel - - -/** -A list of alarm histories in JSON format.
- */ -@property (nonatomic, strong) NSArray *alarmHistoryItems; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSCloudWatchDescribeAlarmsForMetricInput : AWSRequest - - -/** -The list of dimensions associated with the metric.
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -The name of the metric.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -The namespace of the metric.
- */ -@property (nonatomic, strong) NSString *namespace; - -/** -The period in seconds over which the statistic is applied.
- */ -@property (nonatomic, strong) NSNumber *period; - -/** -The statistic for the metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStatistic statistic; - -/** -The unit for the metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStandardUnit unit; - -@end - -/** -The output for the DescribeAlarmsForMetric action.
- */ -@interface AWSCloudWatchDescribeAlarmsForMetricOutput : AWSModel - - -/** -A list of information for each alarm with the specified metric.
- */ -@property (nonatomic, strong) NSArray *metricAlarms; - -@end - -/** - - */ -@interface AWSCloudWatchDescribeAlarmsInput : AWSRequest - - -/** -The action name prefix.
- */ -@property (nonatomic, strong) NSString *actionPrefix; - -/** - The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
A list of alarm names to retrieve information for.
- */ -@property (nonatomic, strong) NSArray *alarmNames; - -/** -The maximum number of alarm descriptions to retrieve.
- */ -@property (nonatomic, strong) NSNumber *maxRecords; - -/** -The token returned by a previous call to indicate that there is more data available.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -The state value to be used in matching alarms.
- */ -@property (nonatomic, assign) AWSCloudWatchStateValue stateValue; - -@end - -/** -The output for the DescribeAlarms action.
- */ -@interface AWSCloudWatchDescribeAlarmsOutput : AWSModel - - -/** -A list of information for the specified alarms.
- */ -@property (nonatomic, strong) NSArray *metricAlarms; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - 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.
- Required parameters: [Name, Value] - */ -@interface AWSCloudWatchDimension : AWSModel - - -/** -The name of the dimension.
- */ -@property (nonatomic, strong) NSString *name; - -/** -The value representing the dimension measurement
- */ -@property (nonatomic, strong) NSString *value; - -@end - -/** - The DimensionFilter data type is used to filter ListMetrics results.
The dimension name to be matched.
- */ -@property (nonatomic, strong) NSString *name; - -/** -The value of the dimension to be matched.
Name without specifying a Value returns all values associated with that Name. The names of the alarms to disable actions for.
- */ -@property (nonatomic, strong) NSArray *alarmNames; - -@end - -/** - - */ -@interface AWSCloudWatchEnableAlarmActionsInput : AWSRequest - - -/** -The names of the alarms to enable actions for.
- */ -@property (nonatomic, strong) NSArray *alarmNames; - -@end - -/** - - */ -@interface AWSCloudWatchGetMetricStatisticsInput : AWSRequest - - -/** -A list of dimensions describing qualities of the metric.
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -The name of the metric, with or without spaces.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -The namespace of the metric, with or without spaces.
- */ -@property (nonatomic, strong) NSString *namespace; - -/** - 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 time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified.
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 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.
- */ -@property (nonatomic, assign) AWSCloudWatchStandardUnit unit; - -@end - -/** -The output for the GetMetricStatistics action.
- */ -@interface AWSCloudWatchGetMetricStatisticsOutput : AWSModel - - -/** -The datapoints for the specified metric.
- */ -@property (nonatomic, strong) NSArray *datapoints; - -/** -A label describing the specified metric.
- */ -@property (nonatomic, strong) NSString *label; - -@end - -/** - - */ -@interface AWSCloudWatchListMetricsInput : AWSRequest - - -/** -A list of dimensions to filter against.
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -The name of the metric to filter against.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -The namespace to filter against.
- */ -@property (nonatomic, strong) NSString *namespace; - -/** -The token returned by a previous call to indicate that there is more data available.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -The output for the ListMetrics action.
- */ -@interface AWSCloudWatchListMetricsOutput : AWSModel - - -/** -A list of metrics used to generate statistics for an AWS account.
- */ -@property (nonatomic, strong) NSArray *metrics; - -/** -A string that marks the start of the next batch of returned results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - 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.
- */ -@interface AWSCloudWatchMetric : AWSModel - - -/** -A list of dimensions associated with the metric.
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -The name of the metric.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -The namespace of the metric.
- */ -@property (nonatomic, strong) NSString *namespace; - -@end - -/** -The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.
- */ -@interface AWSCloudWatchMetricAlarm : AWSModel - - -/** -Indicates whether actions should be executed during any changes to the alarm's state.
- */ -@property (nonatomic, strong) NSNumber *actionsEnabled; - -/** - 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 Amazon Resource Name (ARN) of the alarm.
- */ -@property (nonatomic, strong) NSString *alarmArn; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *alarmConfigurationUpdatedTimestamp; - -/** -The description for the alarm.
- */ -@property (nonatomic, strong) NSString *alarmDescription; - -/** -The name of the alarm.
- */ -@property (nonatomic, strong) NSString *alarmName; - -/** - The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
The list of dimensions associated with the alarm's associated metric.
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -The number of periods over which data is compared to the specified threshold.
- */ -@property (nonatomic, strong) NSNumber *evaluationPeriods; - -/** - 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 name of the alarm's metric.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -The namespace of alarm's associated metric.
- */ -@property (nonatomic, strong) NSString *namespace; - -/** - 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 period in seconds over which the statistic is applied.
- */ -@property (nonatomic, strong) NSNumber *period; - -/** -A human-readable explanation for the alarm's state.
- */ -@property (nonatomic, strong) NSString *stateReason; - -/** -An explanation for the alarm's state in machine-readable JSON format
- */ -@property (nonatomic, strong) NSString *stateReasonData; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *stateUpdatedTimestamp; - -/** -The state value for the alarm.
- */ -@property (nonatomic, assign) AWSCloudWatchStateValue stateValue; - -/** -The statistic to apply to the alarm's associated metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStatistic statistic; - -/** -The value against which the specified statistic is compared.
- */ -@property (nonatomic, strong) NSNumber *threshold; - -/** -The unit of the alarm's associated metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStandardUnit unit; - -@end - -/** - 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.
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).
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -The name of the metric.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -A set of statistical values describing the metric.
- */ -@property (nonatomic, strong) AWSCloudWatchStatisticSet *statisticValues; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -/** -The unit of the metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStandardUnit unit; - -/** -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. Indicates whether or not actions should be executed during any changes to the alarm's state.
- */ -@property (nonatomic, strong) NSNumber *actionsEnabled; - -/** - 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 description for the alarm.
- */ -@property (nonatomic, strong) NSString *alarmDescription; - -/** -The descriptive name for the alarm. This name must be unique within the user's AWS account
- */ -@property (nonatomic, strong) NSString *alarmName; - -/** - The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
The dimensions for the alarm's associated metric.
- */ -@property (nonatomic, strong) NSArray *dimensions; - -/** -The number of periods over which data is compared to the specified threshold.
- */ -@property (nonatomic, strong) NSNumber *evaluationPeriods; - -/** - 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.
- */ -@property (nonatomic, strong) NSString *metricName; - -/** -The namespace for the alarm's associated metric.
- */ -@property (nonatomic, strong) NSString *namespace; - -/** - 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 period in seconds over which the specified statistic is applied.
- */ -@property (nonatomic, strong) NSNumber *period; - -/** -The statistic to apply to the alarm's associated metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStatistic statistic; - -/** -The value against which the specified statistic is compared.
- */ -@property (nonatomic, strong) NSNumber *threshold; - -/** -The unit for the alarm's associated metric.
- */ -@property (nonatomic, assign) AWSCloudWatchStandardUnit unit; - -@end - -/** - - */ -@interface AWSCloudWatchPutMetricDataInput : AWSRequest - - -/** -A list of data describing the metric.
- */ -@property (nonatomic, strong) NSArray *metricData; - -/** -The namespace for the metric data.
The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
- */ -@property (nonatomic, strong) NSString *alarmName; - -/** -The reason that this alarm is set to this specific state (in human-readable text format)
- */ -@property (nonatomic, strong) NSString *stateReason; - -/** -The reason that this alarm is set to this specific state (in machine-readable JSON format)
- */ -@property (nonatomic, strong) NSString *stateReasonData; - -/** -The value of the state.
- */ -@property (nonatomic, assign) AWSCloudWatchStateValue stateValue; - -@end - -/** - The StatisticSet data type describes the StatisticValues component of MetricDatum, and represents a set of statistics that describes a specific metric.
The maximum value of the sample set.
- */ -@property (nonatomic, strong) NSNumber *maximum; - -/** -The minimum value of the sample set.
- */ -@property (nonatomic, strong) NSNumber *minimum; - -/** -The number of samples used for the statistic set.
- */ -@property (nonatomic, strong) NSNumber *sampleCount; - -/** -The sum of values for the sample set.
- */ -@property (nonatomic, strong) NSNumber *sum; - -@end diff --git a/Frameworks/AWSCloudWatch.framework/Headers/AWSCloudWatchService.h b/Frameworks/AWSCloudWatch.framework/Headers/AWSCloudWatchService.h deleted file mode 100644 index 580342a..0000000 --- a/Frameworks/AWSCloudWatch.framework/Headers/AWSCloudWatchService.h +++ /dev/null @@ -1,311 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importThis 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:
Deletes all specified alarms. In the event of an error, no alarms are deleted.
- - @param request A container for the necessary parameters to execute the DeleteAlarms service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCloudWatchErrorDomain` domian and the following error code: `AWSCloudWatchErrorResourceNotFound`. - - @see AWSCloudWatchDeleteAlarmsInput - */ -- (BFTask *)deleteAlarms:(AWSCloudWatchDeleteAlarmsInput *)request; - -/** -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.
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.
- - @param request A container for the necessary parameters to execute the DescribeAlarms service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCloudWatchDescribeAlarmsOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSCloudWatchErrorDomain` domian and the following error code: `AWSCloudWatchErrorInvalidNextToken`. - - @see AWSCloudWatchDescribeAlarmsInput - @see AWSCloudWatchDescribeAlarmsOutput - */ -- (BFTask *)describeAlarms:(AWSCloudWatchDescribeAlarmsInput *)request; - -/** -Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
- - @param request A container for the necessary parameters to execute the DescribeAlarmsForMetric service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCloudWatchDescribeAlarmsForMetricOutput`. - - @see AWSCloudWatchDescribeAlarmsForMetricInput - @see AWSCloudWatchDescribeAlarmsForMetricOutput - */ -- (BFTask *)describeAlarmsForMetric:(AWSCloudWatchDescribeAlarmsForMetricInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DisableAlarmActions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSCloudWatchDisableAlarmActionsInput - */ -- (BFTask *)disableAlarmActions:(AWSCloudWatchDisableAlarmActionsInput *)request; - -/** -Enables actions for the specified alarms.
- - @param request A container for the necessary parameters to execute the EnableAlarmActions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSCloudWatchEnableAlarmActionsInput - */ -- (BFTask *)enableAlarmActions:(AWSCloudWatchEnableAlarmActionsInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetMetricStatistics service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCloudWatchGetMetricStatisticsOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSCloudWatchErrorDomain` domian and the following error code: `AWSCloudWatchErrorInvalidParameterValue`, `AWSCloudWatchErrorMissingRequiredParameter`, `AWSCloudWatchErrorInvalidParameterCombination`, `AWSCloudWatchErrorInternalService`. - - @see AWSCloudWatchGetMetricStatisticsInput - @see AWSCloudWatchGetMetricStatisticsOutput - */ -- (BFTask *)getMetricStatistics:(AWSCloudWatchGetMetricStatisticsInput *)request; - -/** -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.
NextToken values with subsequent ListMetrics operations. ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. 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.
StateValue is left unchanged. 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.
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.
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.
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.
NextToken values with subsequent ListMetrics operations. ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. 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.
StateValue is left unchanged. 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.
Name without specifying a Value returns all values associated with that Name. 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.
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 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.
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.
BulkPublish operation.
+ The input for the BulkPublish operation.
Required parameters: [IdentityPoolId]
*/
@interface AWSCognitoSyncBulkPublishRequest : AWSRequest
@@ -130,7 +141,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) {
/**
- The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.
+ The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.
*/
@property (nonatomic, strong) NSString *roleArn;
@@ -140,7 +151,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) {
@property (nonatomic, strong) NSString *streamName;
/**
- Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled.
DISABLEDStreaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
*/ @property (nonatomic, assign) AWSCognitoSyncStreamingStatus streamingStatus; @@ -323,7 +334,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** - The input for theGetBulkPublishDetails operation.
+ The input for the GetBulkPublishDetails operation.
Required parameters: [IdentityPoolId]
*/
@interface AWSCognitoSyncGetBulkPublishDetailsRequest : AWSRequest
@@ -337,13 +348,13 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) {
@end
/**
- The output for the GetBulkPublishDetails operation.
+ The output for the GetBulkPublishDetails operation.
*/
@interface AWSCognitoSyncGetBulkPublishDetailsResponse : AWSModel
/**
- If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
+ If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
*/
@property (nonatomic, strong) NSDate *bulkPublishCompleteTime;
@@ -353,7 +364,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) {
@property (nonatomic, strong) NSDate *bulkPublishStartTime;
/**
- Status of the last bulk publish operation, valid values are: NOT_STARTED - No bulk publish has been requested for this identity pool
IN_PROGRESS - Data is being published to the configured stream
SUCCEEDED - All data for the identity pool has been published to the configured stream
FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
NOT_STARTED - No bulk publish has been requested for this identity pool
IN_PROGRESS - Data is being published to the configured stream
SUCCEEDED - All data for the identity pool has been published to the configured stream
FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
*/ @property (nonatomic, assign) AWSCognitoSyncBulkPublishStatus bulkPublishStatus; @@ -370,33 +381,34 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** - +A request for a list of the configured Cognito Events
+ Required parameters: [IdentityPoolId] */ @interface AWSCognitoSyncGetCognitoEventsRequest : AWSRequest /** - +The Cognito Identity Pool ID for the request
*/ @property (nonatomic, strong) NSString *identityPoolId; @end /** - +The response from the GetCognitoEvents request
*/ @interface AWSCognitoSyncGetCognitoEventsResponse : AWSModel /** - +The Cognito Events returned from the GetCognitoEvents request
*/ @property (nonatomic, strong) NSDictionary *events; @end /** -The input for the GetIdentityPoolConfiguration operation.
The input for the GetIdentityPoolConfiguration operation.
Required parameters: [IdentityPoolId] */ @interface AWSCognitoSyncGetIdentityPoolConfigurationRequest : AWSRequest @@ -410,7 +422,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -The output for the GetIdentityPoolConfiguration operation.
The output for the GetIdentityPoolConfiguration operation.
*/ @interface AWSCognitoSyncGetIdentityPoolConfigurationResponse : AWSModel @@ -779,7 +791,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -A request to RegisterDevice.
A request to RegisterDevice.
Required parameters: [IdentityPoolId, IdentityId, Platform, Token] */ @interface AWSCognitoSyncRegisterDeviceRequest : AWSRequest @@ -808,7 +820,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -Response to a RegisterDevice request.
Response to a RegisterDevice request.
*/ @interface AWSCognitoSyncRegisterDeviceResponse : AWSModel @@ -821,25 +833,26 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** - +A request to configure Cognito Events"
" + Required parameters: [IdentityPoolId, Events] */ @interface AWSCognitoSyncSetCognitoEventsRequest : AWSRequest /** - +The events to configure
*/ @property (nonatomic, strong) NSDictionary *events; /** - +The Cognito Identity Pool to use when configuring Cognito Events
*/ @property (nonatomic, strong) NSString *identityPoolId; @end /** -The input for the SetIdentityPoolConfiguration operation.
The input for the SetIdentityPoolConfiguration operation.
Required parameters: [IdentityPoolId] */ @interface AWSCognitoSyncSetIdentityPoolConfigurationRequest : AWSRequest @@ -863,7 +876,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -The output for the SetIdentityPoolConfiguration operation
The output for the SetIdentityPoolConfiguration operation
*/ @interface AWSCognitoSyncSetIdentityPoolConfigurationResponse : AWSModel @@ -886,7 +899,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -A request to SubscribeToDatasetRequest.
A request to SubscribeToDatasetRequest.
Required parameters: [IdentityPoolId, IdentityId, DatasetName, DeviceId] */ @interface AWSCognitoSyncSubscribeToDatasetRequest : AWSRequest @@ -915,7 +928,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -Response to a SubscribeToDataset request.
Response to a SubscribeToDataset request.
*/ @interface AWSCognitoSyncSubscribeToDatasetResponse : AWSModel @@ -923,7 +936,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -A request to UnsubscribeFromDataset.
A request to UnsubscribeFromDataset.
Required parameters: [IdentityPoolId, IdentityId, DatasetName, DeviceId] */ @interface AWSCognitoSyncUnsubscribeFromDatasetRequest : AWSRequest @@ -952,7 +965,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { @end /** -Response to an UnsubscribeFromDataset request.
Response to an UnsubscribeFromDataset request.
*/ @interface AWSCognitoSyncUnsubscribeFromDatasetResponse : AWSModel @@ -967,7 +980,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoSyncStreamingStatus) { /** - Intended to supply a device ID that will populate thelastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.
+ Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.
*/
@property (nonatomic, strong) NSString *clientContext;
diff --git a/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDB.h b/Frameworks/AWSCognito.framework/Headers/AWSCognitoSyncResources.h
similarity index 83%
rename from Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDB.h
rename to Frameworks/AWSCognito.framework/Headers/AWSCognitoSyncResources.h
index 56955cb..62d8a3a 100644
--- a/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDB.h
+++ b/Frameworks/AWSCognito.framework/Headers/AWSCognitoSyncResources.h
@@ -1,12 +1,12 @@
/*
Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
+
Licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License.
A copy of the License is located at
-
+
http://aws.amazon.com/apache2.0
-
+
or in the "license" file accompanying this file. This file is distributed
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the specific language governing
@@ -14,6 +14,11 @@
*/
#import Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the BulkPublish service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncBulkPublishResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorDuplicateRequest`, `AWSCognitoSyncErrorAlreadyStreamed`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncBulkPublishResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorDuplicateRequest`, `AWSCognitoSyncErrorAlreadyStreamed`. @see AWSCognitoSyncBulkPublishRequest @see AWSCognitoSyncBulkPublishResponse */ -- (BFTask *)bulkPublish:(AWSCognitoSyncBulkPublishRequest *)request; +- (AWSTask *)bulkPublish:(AWSCognitoSyncBulkPublishRequest *)request; /** -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 subsequent operation on this dataset will result in a ResourceNotFoundException.
DeleteDataset can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
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 subsequent operation on this dataset will result in a ResourceNotFoundException.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
@param request A container for the necessary parameters to execute the DeleteDataset service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDeleteDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorResourceConflict`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDeleteDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorResourceConflict`. @see AWSCognitoSyncDeleteDatasetRequest @see AWSCognitoSyncDeleteDatasetResponse */ -- (BFTask *)deleteDataset:(AWSCognitoSyncDeleteDatasetRequest *)request; +- (AWSTask *)deleteDataset:(AWSCognitoSyncDeleteDatasetRequest *)request; /** -Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
DescribeDataset can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
@param request A container for the necessary parameters to execute the DescribeDataset service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDescribeDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDescribeDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncDescribeDatasetRequest @see AWSCognitoSyncDescribeDatasetResponse */ -- (BFTask *)describeDataset:(AWSCognitoSyncDescribeDatasetRequest *)request; +- (AWSTask *)describeDataset:(AWSCognitoSyncDescribeDatasetRequest *)request; /** -Gets usage details (for example, data storage) about a particular identity pool.
DescribeIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
Gets usage details (for example, data storage) about a particular identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the DescribeIdentityPoolUsage service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDescribeIdentityPoolUsageResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDescribeIdentityPoolUsageResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncDescribeIdentityPoolUsageRequest @see AWSCognitoSyncDescribeIdentityPoolUsageResponse */ -- (BFTask *)describeIdentityPoolUsage:(AWSCognitoSyncDescribeIdentityPoolUsageRequest *)request; +- (AWSTask *)describeIdentityPoolUsage:(AWSCognitoSyncDescribeIdentityPoolUsageRequest *)request; /** -Gets usage information for an identity, including number of datasets and data usage.
DescribeIdentityUsage can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
Gets usage information for an identity, including number of datasets and data usage.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
@param request A container for the necessary parameters to execute the DescribeIdentityUsage service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDescribeIdentityUsageResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncDescribeIdentityUsageResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncDescribeIdentityUsageRequest @see AWSCognitoSyncDescribeIdentityUsageResponse */ -- (BFTask *)describeIdentityUsage:(AWSCognitoSyncDescribeIdentityUsageRequest *)request; +- (AWSTask *)describeIdentityUsage:(AWSCognitoSyncDescribeIdentityUsageRequest *)request; /** - Get the status of the last BulkPublish operation for an identity pool. +Get the status of the last BulkPublish operation for an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the GetBulkPublishDetails service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncGetBulkPublishDetailsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncGetBulkPublishDetailsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`. @see AWSCognitoSyncGetBulkPublishDetailsRequest @see AWSCognitoSyncGetBulkPublishDetailsResponse */ -- (BFTask *)getBulkPublishDetails:(AWSCognitoSyncGetBulkPublishDetailsRequest *)request; +- (AWSTask *)getBulkPublishDetails:(AWSCognitoSyncGetBulkPublishDetailsRequest *)request; /** - GetCognitoEvents +Gets the events and the corresponding Lambda functions associated with an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the GetCognitoEvents service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncGetCognitoEventsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncGetCognitoEventsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncGetCognitoEventsRequest @see AWSCognitoSyncGetCognitoEventsResponse */ -- (BFTask *)getCognitoEvents:(AWSCognitoSyncGetCognitoEventsRequest *)request; +- (AWSTask *)getCognitoEvents:(AWSCognitoSyncGetCognitoEventsRequest *)request; /** -Gets the configuration settings of an identity pool.
+Gets the configuration settings of an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the GetIdentityPoolConfiguration service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncGetIdentityPoolConfigurationResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncGetIdentityPoolConfigurationResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncGetIdentityPoolConfigurationRequest @see AWSCognitoSyncGetIdentityPoolConfigurationResponse */ -- (BFTask *)getIdentityPoolConfiguration:(AWSCognitoSyncGetIdentityPoolConfigurationRequest *)request; +- (AWSTask *)getIdentityPoolConfiguration:(AWSCognitoSyncGetIdentityPoolConfigurationRequest *)request; /** -Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
@param request A container for the necessary parameters to execute the ListDatasets service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncListDatasetsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncListDatasetsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncListDatasetsRequest @see AWSCognitoSyncListDatasetsResponse */ -- (BFTask *)listDatasets:(AWSCognitoSyncListDatasetsRequest *)request; +- (AWSTask *)listDatasets:(AWSCognitoSyncListDatasetsRequest *)request; /** -Gets a list of identity pools registered with Cognito.
ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
Gets a list of identity pools registered with Cognito.
ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the ListIdentityPoolUsage service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncListIdentityPoolUsageResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncListIdentityPoolUsageResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncListIdentityPoolUsageRequest @see AWSCognitoSyncListIdentityPoolUsageResponse */ -- (BFTask *)listIdentityPoolUsage:(AWSCognitoSyncListIdentityPoolUsageRequest *)request; +- (AWSTask *)listIdentityPoolUsage:(AWSCognitoSyncListIdentityPoolUsageRequest *)request; /** -Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
@param request A container for the necessary parameters to execute the ListRecords service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncListRecordsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncListRecordsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorInternalError`. @see AWSCognitoSyncListRecordsRequest @see AWSCognitoSyncListRecordsResponse */ -- (BFTask *)listRecords:(AWSCognitoSyncListRecordsRequest *)request; +- (AWSTask *)listRecords:(AWSCognitoSyncListRecordsRequest *)request; /** -Registers a device to receive push sync notifications.
+Registers a device to receive push sync notifications.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
@param request A container for the necessary parameters to execute the RegisterDevice service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncRegisterDeviceResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorInvalidConfiguration`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncRegisterDeviceResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorInvalidConfiguration`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncRegisterDeviceRequest @see AWSCognitoSyncRegisterDeviceResponse */ -- (BFTask *)registerDevice:(AWSCognitoSyncRegisterDeviceRequest *)request; +- (AWSTask *)registerDevice:(AWSCognitoSyncRegisterDeviceRequest *)request; /** - SetCognitoEvents +Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the SetCognitoEvents service method. - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncSetCognitoEventsRequest */ -- (BFTask *)setCognitoEvents:(AWSCognitoSyncSetCognitoEventsRequest *)request; +- (AWSTask *)setCognitoEvents:(AWSCognitoSyncSetCognitoEventsRequest *)request; /** -Sets the necessary configuration for push sync.
+Sets the necessary configuration for push sync.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
@param request A container for the necessary parameters to execute the SetIdentityPoolConfiguration service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncSetIdentityPoolConfigurationResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncSetIdentityPoolConfigurationResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorLimitExceeded`. @see AWSCognitoSyncSetIdentityPoolConfigurationRequest @see AWSCognitoSyncSetIdentityPoolConfigurationResponse */ -- (BFTask *)setIdentityPoolConfiguration:(AWSCognitoSyncSetIdentityPoolConfigurationRequest *)request; +- (AWSTask *)setIdentityPoolConfiguration:(AWSCognitoSyncSetIdentityPoolConfigurationRequest *)request; /** -Subscribes to receive notifications when a dataset is modified by another device.
+Subscribes to receive notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
@param request A container for the necessary parameters to execute the SubscribeToDataset service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncSubscribeToDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorInvalidConfiguration`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncSubscribeToDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorInvalidConfiguration`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncSubscribeToDatasetRequest @see AWSCognitoSyncSubscribeToDatasetResponse */ -- (BFTask *)subscribeToDataset:(AWSCognitoSyncSubscribeToDatasetRequest *)request; +- (AWSTask *)subscribeToDataset:(AWSCognitoSyncSubscribeToDatasetRequest *)request; /** -Unsubscribes from receiving notifications when a dataset is modified by another device.
+Unsubscribes from receiving notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
@param request A container for the necessary parameters to execute the UnsubscribeFromDataset service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncUnsubscribeFromDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorInvalidConfiguration`, `AWSCognitoSyncErrorTooManyRequests`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncUnsubscribeFromDatasetResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorInternalError`, `AWSCognitoSyncErrorInvalidConfiguration`, `AWSCognitoSyncErrorTooManyRequests`. @see AWSCognitoSyncUnsubscribeFromDatasetRequest @see AWSCognitoSyncUnsubscribeFromDatasetResponse */ -- (BFTask *)unsubscribeFromDataset:(AWSCognitoSyncUnsubscribeFromDatasetRequest *)request; +- (AWSTask *)unsubscribeFromDataset:(AWSCognitoSyncUnsubscribeFromDatasetRequest *)request; /** -Posts updates to records and adds and deletes records for a dataset and user.
UpdateRecords can only be called with temporary user credentials provided by Cognito Identity. You cannot make this API call with developer credentials.
Posts updates to records and adds and deletes records for a dataset and user.
The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.
For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
@param request A container for the necessary parameters to execute the UpdateRecords service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncUpdateRecordsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorLimitExceeded`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorResourceConflict`, `AWSCognitoSyncErrorInvalidLambdaFunctionOutput`, `AWSCognitoSyncErrorLambdaThrottled`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoSyncUpdateRecordsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoSyncErrorDomain` domian and the following error code: `AWSCognitoSyncErrorInvalidParameter`, `AWSCognitoSyncErrorLimitExceeded`, `AWSCognitoSyncErrorNotAuthorized`, `AWSCognitoSyncErrorResourceNotFound`, `AWSCognitoSyncErrorResourceConflict`, `AWSCognitoSyncErrorInvalidLambdaFunctionOutput`, `AWSCognitoSyncErrorLambdaThrottled`, `AWSCognitoSyncErrorTooManyRequests`, `AWSCognitoSyncErrorInternalError`. @see AWSCognitoSyncUpdateRecordsRequest @see AWSCognitoSyncUpdateRecordsResponse */ -- (BFTask *)updateRecords:(AWSCognitoSyncUpdateRecordsRequest *)request; +- (AWSTask *)updateRecords:(AWSCognitoSyncUpdateRecordsRequest *)request; @end diff --git a/Frameworks/AWSCognito.framework/Info.plist b/Frameworks/AWSCognito.framework/Info.plist index 4924529..f7c0fb4 100644 Binary files a/Frameworks/AWSCognito.framework/Info.plist and b/Frameworks/AWSCognito.framework/Info.plist differ diff --git a/Frameworks/AWSCognito.framework/_CodeSignature/CodeResources b/Frameworks/AWSCognito.framework/_CodeSignature/CodeResources index 867ec6f..48bc547 100644 --- a/Frameworks/AWSCognito.framework/_CodeSignature/CodeResources +++ b/Frameworks/AWSCognito.framework/_CodeSignature/CodeResources @@ -6,7 +6,7 @@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.
If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
", - "operations":{ - "BulkPublish":{ - "name":"BulkPublish", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/bulkpublish", - "responseCode":200 - }, - "input":{ - "shape":"BulkPublishRequest", - "documentation":"The input for theBulkPublish operation."
- },
- "output":{
- "shape":"BulkPublishResponse",
- "documentation":"The output for the BulkPublish operation."
- },
- "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."
- },
- {
- "shape":"DuplicateRequestException",
- "error":{
- "code":"DuplicateRequest",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool."
- },
- {
- "shape":"AlreadyStreamedException",
- "error":{
- "code":"AlreadyStreamed",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully."
- }
- ],
- "documentation":"Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation."
- },
- "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."
- },
- {
- "shape":"TooManyRequestsException",
- "error":{
- "code":"TooManyRequests",
- "httpStatusCode":429,
- "senderFault":true
- },
- "exception":true,
- "documentation":"Thrown if the request is throttled."
- },
- {
- "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."
- }
- ],
- "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 subsequent operation on this dataset will result in a ResourceNotFoundException.
DeleteDataset can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
DescribeDataset can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
Gets usage details (for example, data storage) about a particular identity pool.
DescribeIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
Gets usage information for an identity, including number of datasets and data usage.
DescribeIdentityUsage can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
GetBulkPublishDetails operation."
- },
- "output":{
- "shape":"GetBulkPublishDetailsResponse",
- "documentation":"The output for the GetBulkPublishDetails operation."
- },
- "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":"Get the status of the last BulkPublish operation for an identity pool."
- },
- "GetCognitoEvents":{
- "name":"GetCognitoEvents",
- "http":{
- "method":"GET",
- "requestUri":"/identitypools/{IdentityPoolId}/events",
- "responseCode":200
- },
- "input":{"shape":"GetCognitoEventsRequest"},
- "output":{"shape":"GetCognitoEventsResponse"},
- "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":"ResourceNotFoundException",
- "error":{
- "code":"ResourceNotFound",
- "httpStatusCode":404,
- "senderFault":true
- },
- "exception":true,
- "documentation":"Thrown if the resource doesn't exist."
- },
- {
- "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":"InternalErrorException",
- "error":{
- "code":"InternalError",
- "httpStatusCode":500
- },
- "exception":true,
- "fault":true,
- "documentation":"Indicates an internal service error."
- },
- {
- "shape":"TooManyRequestsException",
- "error":{
- "code":"TooManyRequests",
- "httpStatusCode":429,
- "senderFault":true
- },
- "exception":true,
- "documentation":"Thrown if the request is throttled."
- }
- ]
- },
- "GetIdentityPoolConfiguration":{
- "name":"GetIdentityPoolConfiguration",
- "http":{
- "method":"GET",
- "requestUri":"/identitypools/{IdentityPoolId}/configuration",
- "responseCode":200
- },
- "input":{
- "shape":"GetIdentityPoolConfigurationRequest",
- "documentation":"The input for the GetIdentityPoolConfiguration operation.
The output for the GetIdentityPoolConfiguration operation.
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." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } - ], - "documentation":"Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
Gets a list of identity pools registered with Cognito.
ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
A request to RegisterDevice.
Response to a RegisterDevice request.
Registers a device to receive push sync notifications.
" - }, - "SetCognitoEvents":{ - "name":"SetCognitoEvents", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/events", - "responseCode":200 - }, - "input":{"shape":"SetCognitoEventsRequest"}, - "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":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "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":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } - ] - }, - "SetIdentityPoolConfiguration":{ - "name":"SetIdentityPoolConfiguration", - "http":{ - "method":"POST", - "requestUri":"/identitypools/{IdentityPoolId}/configuration", - "responseCode":200 - }, - "input":{ - "shape":"SetIdentityPoolConfigurationRequest", - "documentation":"The input for the SetIdentityPoolConfiguration operation.
The output for the SetIdentityPoolConfiguration operation
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.
Unsubscribes 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":"InvalidLambdaFunctionOutputException", - "error":{ - "code":"InvalidLambdaFunctionOutput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - { - "shape":"LambdaThrottledException", - "error":{ - "code":"LambdaThrottled", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - { - "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 adds and deletes records for a dataset and user.
UpdateRecords can only be called with temporary user credentials provided by Cognito Identity. You cannot make this API call with developer credentials.
AlreadyStreamedException exception."
- }
- },
- "error":{
- "code":"AlreadyStreamed",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully."
- },
- "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"},
- "BulkPublishRequest":{
- "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":"The input for the BulkPublish operation."
- },
- "BulkPublishResponse":{
- "type":"structure",
- "members":{
- "IdentityPoolId":{
- "shape":"IdentityPoolId",
- "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region."
- }
- },
- "documentation":"The output for the BulkPublish operation."
- },
- "BulkPublishStatus":{
- "type":"string",
- "enum":[
- "NOT_STARTED",
- "IN_PROGRESS",
- "FAILED",
- "SUCCEEDED"
- ]
- },
- "ClientContext":{"type":"string"},
- "CognitoEventType":{"type":"string"},
- "CognitoStreams":{
- "type":"structure",
- "members":{
- "StreamName":{
- "shape":"StreamName",
- "documentation":"The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool."
- },
- "RoleArn":{
- "shape":"AssumeRoleArn",
- "documentation":"The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream."
- },
- "StreamingStatus":{
- "shape":"StreamingStatus",
- "documentation":"Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled.
DISABLEDStreaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
DuplicateRequestException exception."
- }
- },
- "error":{
- "code":"DuplicateRequest",
- "httpStatusCode":400,
- "senderFault":true
- },
- "exception":true,
- "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool."
- },
- "Events":{
- "type":"map",
- "key":{"shape":"CognitoEventType"},
- "value":{"shape":"LambdaFunctionArn"},
- "max":1
- },
- "ExceptionMessage":{"type":"string"},
- "GetBulkPublishDetailsRequest":{
- "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":"The input for the GetBulkPublishDetails operation."
- },
- "GetBulkPublishDetailsResponse":{
- "type":"structure",
- "members":{
- "IdentityPoolId":{
- "shape":"IdentityPoolId",
- "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region."
- },
- "BulkPublishStartTime":{
- "shape":"Date",
- "documentation":"The date/time at which the last bulk publish was initiated."
- },
- "BulkPublishCompleteTime":{
- "shape":"Date",
- "documentation":"If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed."
- },
- "BulkPublishStatus":{
- "shape":"BulkPublishStatus",
- "documentation":"Status of the last bulk publish operation, valid values are: NOT_STARTED - No bulk publish has been requested for this identity pool
IN_PROGRESS - Data is being published to the configured stream
SUCCEEDED - All data for the identity pool has been published to the configured stream
FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
GetBulkPublishDetails operation."
- },
- "GetCognitoEventsRequest":{
- "type":"structure",
- "required":["IdentityPoolId"],
- "members":{
- "IdentityPoolId":{
- "shape":"IdentityPoolId",
- "location":"uri",
- "locationName":"IdentityPoolId"
- }
- }
- },
- "GetCognitoEventsResponse":{
- "type":"structure",
- "members":{
- "Events":{"shape":"Events"}
- }
- },
- "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":"The input for the GetIdentityPoolConfiguration operation.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
" - }, - "PushSync":{ - "shape":"PushSync", - "documentation":"Options to apply to this identity pool for push synchronization.
" - }, - "CognitoStreams":{ - "shape":"CognitoStreams", - "documentation":"Options to apply to this identity pool for Amazon Cognito streams." - } - }, - "documentation":"The output for the GetIdentityPoolConfiguration operation.
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":"Options to apply to this identity pool for push synchronization.
" - }, - "CognitoStreams":{ - "shape":"CognitoStreams", - "documentation":"Options to apply to this identity pool for Amazon Cognito streams." - } - }, - "documentation":"The input for the SetIdentityPoolConfiguration operation.
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
" - }, - "PushSync":{ - "shape":"PushSync", - "documentation":"Options to apply to this identity pool for push synchronization.
" - }, - "CognitoStreams":{ - "shape":"CognitoStreams", - "documentation":"Options to apply to this identity pool for Amazon Cognito streams." - } - }, - "documentation":"The output for the SetIdentityPoolConfiguration operation
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/Frameworks/AWSCore.framework/AWSCore b/Frameworks/AWSCore.framework/AWSCore
index c2026d9..5527bd9 100755
Binary files a/Frameworks/AWSCore.framework/AWSCore and b/Frameworks/AWSCore.framework/AWSCore differ
diff --git a/Frameworks/AWSCore.framework/Headers/AWSBolts.h b/Frameworks/AWSCore.framework/Headers/AWSBolts.h
new file mode 100644
index 0000000..7c9d01c
--- /dev/null
+++ b/Frameworks/AWSCore.framework/Headers/AWSBolts.h
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2014, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+#import "AWSExecutor.h"
+#import "AWSTask.h"
+#import "AWSTaskCompletionSource.h"
+
+/*! @abstract 80175001: There were multiple errors. */
+extern NSInteger const kAWSMultipleErrorsError;
diff --git a/Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityModel.h b/Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityModel.h
index c29abfb..755c713 100644
--- a/Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityModel.h
+++ b/Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityModel.h
@@ -25,6 +25,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) {
AWSCognitoIdentityErrorInvalidClientTokenId,
AWSCognitoIdentityErrorMissingAuthenticationToken,
AWSCognitoIdentityErrorDeveloperUserAlreadyRegistered,
+ AWSCognitoIdentityErrorExternalService,
AWSCognitoIdentityErrorInternalError,
AWSCognitoIdentityErrorInvalidIdentityPoolConfiguration,
AWSCognitoIdentityErrorInvalidParameter,
@@ -100,28 +101,28 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) {
@end
/**
-
+ Credentials for the the provided identity ID.
*/ @interface AWSCognitoIdentityCredentials : AWSModel /** - +The Access Key portion of the credentials.
*/ @property (nonatomic, strong) NSString *accessKeyId; /** - +The date at which these credentials will expire.
*/ @property (nonatomic, strong) NSDate *expiration; /** - +The Secret Access Key portion of the credentials
*/ @property (nonatomic, strong) NSString *secretKey; /** - +The Session Token portion of the credentials
*/ @property (nonatomic, strong) NSString *sessionToken; @@ -142,13 +143,14 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { @end /** - +Input to the DescribeIdentity action.
A unique identifier in the format REGION:GUID.
*/ @property (nonatomic, strong) NSString *identityId; @@ -169,36 +171,37 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { @end /** - +Input to the GetCredentialsForIdentity action.
A unique identifier in the format REGION:GUID.
*/ @property (nonatomic, strong) NSString *identityId; /** - +A set of optional name-value pairs that map provider names to provider tokens.
*/ @property (nonatomic, strong) NSDictionary *logins; @end /** - +Returned in response to a successful GetCredentialsForIdentity operation.
Credentials for the the provided identity ID.
*/ @property (nonatomic, strong) AWSCognitoIdentityCredentials *credentials; /** - +A unique identifier in the format REGION:GUID.
*/ @property (nonatomic, strong) NSString *identityId; @@ -222,7 +225,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { @property (nonatomic, strong) NSString *identityPoolId; /** -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.comaccounts.google.comwww.amazon.comA set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
graph.facebook.comaccounts.google.comwww.amazon.comwww.twitter.comwww.digits.comInput to the GetIdentityPoolRoles action.
An identity pool ID in the format REGION:GUID.
*/ @property (nonatomic, strong) NSString *identityPoolId; @end /** - +Returned in response to a successful GetIdentityPoolRoles operation.
An identity pool ID in the format REGION:GUID.
*/ @property (nonatomic, strong) NSString *identityPoolId; /** - +The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
*/ @property (nonatomic, strong) NSDictionary *roles; @@ -332,7 +336,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { @property (nonatomic, strong) NSString *identityId; /** - A set of optional name-value pairs that map provider names to provider tokens. + A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com or any other OpenId Connect provider, always include the id_token. */ @property (nonatomic, strong) NSDictionary *logins; @@ -363,7 +367,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { /** - +Date on which the identity was created.
*/ @property (nonatomic, strong) NSDate *creationDate; @@ -373,7 +377,7 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { @property (nonatomic, strong) NSString *identityId; /** - +Date on which the identity was last modified.
*/ @property (nonatomic, strong) NSDate *lastModifiedDate; @@ -625,18 +629,19 @@ typedef NS_ENUM(NSInteger, AWSCognitoIdentityErrorType) { @end /** - +Input to the SetIdentityPoolRoles action.
An identity pool ID in the format REGION:GUID.
*/ @property (nonatomic, strong) NSString *identityPoolId; /** - +The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
*/ @property (nonatomic, strong) NSDictionary *roles; diff --git a/Frameworks/AWSAutoScaling.framework/Headers/AWSAutoScaling.h b/Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityResources.h similarity index 82% rename from Frameworks/AWSAutoScaling.framework/Headers/AWSAutoScaling.h rename to Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityResources.h index 95d718c..1599e2d 100644 --- a/Frameworks/AWSAutoScaling.framework/Headers/AWSAutoScaling.h +++ b/Frameworks/AWSCore.framework/Headers/AWSCognitoIdentityResources.h @@ -1,12 +1,12 @@ /* Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - + Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at - + http://aws.amazon.com/apache2.0 - + or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing @@ -14,5 +14,11 @@ */ #importAmazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.
Next, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
+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.
*/ @interface AWSCognitoIdentity : AWSService @@ -183,203 +183,203 @@ - (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerCognitoIdentityWithConfiguration:forKey:' and '+ CognitoIdentityForKey:' instead."))); /** -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.
+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. You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the CreateIdentityPool service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityPool`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorLimitExceeded`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityPool`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorLimitExceeded`. @see AWSCognitoIdentityCreateIdentityPoolInput @see AWSCognitoIdentityIdentityPool */ -- (BFTask *)createIdentityPool:(AWSCognitoIdentityCreateIdentityPoolInput *)request; +- (AWSTask *)createIdentityPool:(AWSCognitoIdentityCreateIdentityPoolInput *)request; /** -Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
+Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the DeleteIdentityPool service method. - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityDeleteIdentityPoolInput */ -- (BFTask *)deleteIdentityPool:(AWSCognitoIdentityDeleteIdentityPoolInput *)request; +- (AWSTask *)deleteIdentityPool:(AWSCognitoIdentityDeleteIdentityPoolInput *)request; /** - DescribeIdentity +Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the DescribeIdentity service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityDescription`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityDescription`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityDescribeIdentityInput @see AWSCognitoIdentityIdentityDescription */ -- (BFTask *)describeIdentity:(AWSCognitoIdentityDescribeIdentityInput *)request; +- (AWSTask *)describeIdentity:(AWSCognitoIdentityDescribeIdentityInput *)request; /** -Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
+Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the DescribeIdentityPool service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityPool`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityPool`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityDescribeIdentityPoolInput @see AWSCognitoIdentityIdentityPool */ -- (BFTask *)describeIdentityPool:(AWSCognitoIdentityDescribeIdentityPoolInput *)request; +- (AWSTask *)describeIdentityPool:(AWSCognitoIdentityDescribeIdentityPoolInput *)request; /** - GetCredentialsForIdentity +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.
This is a public API. You do not need any credentials to call this API.
@param request A container for the necessary parameters to execute the GetCredentialsForIdentity service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetCredentialsForIdentityResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInvalidIdentityPoolConfiguration`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetCredentialsForIdentityResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInvalidIdentityPoolConfiguration`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorExternalService`. @see AWSCognitoIdentityGetCredentialsForIdentityInput @see AWSCognitoIdentityGetCredentialsForIdentityResponse */ -- (BFTask *)getCredentialsForIdentity:(AWSCognitoIdentityGetCredentialsForIdentityInput *)request; +- (AWSTask *)getCredentialsForIdentity:(AWSCognitoIdentityGetCredentialsForIdentityInput *)request; /** -Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
+Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
token+";"+tokenSecret.
This is a public API. You do not need any credentials to call this API.
@param request A container for the necessary parameters to execute the GetId service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetIdResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorLimitExceeded`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetIdResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorLimitExceeded`, `AWSCognitoIdentityErrorExternalService`. @see AWSCognitoIdentityGetIdInput @see AWSCognitoIdentityGetIdResponse */ -- (BFTask *)getId:(AWSCognitoIdentityGetIdInput *)request; +- (AWSTask *)getId:(AWSCognitoIdentityGetIdInput *)request; /** - GetIdentityPoolRoles +Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the GetIdentityPoolRoles service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetIdentityPoolRolesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetIdentityPoolRolesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityGetIdentityPoolRolesInput @see AWSCognitoIdentityGetIdentityPoolRolesResponse */ -- (BFTask *)getIdentityPoolRoles:(AWSCognitoIdentityGetIdentityPoolRolesInput *)request; +- (AWSTask *)getIdentityPoolRoles:(AWSCognitoIdentityGetIdentityPoolRolesInput *)request; /** -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.
+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.
This is a public API. You do not need any credentials to call this API.
@param request A container for the necessary parameters to execute the GetOpenIdToken service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetOpenIdTokenResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetOpenIdTokenResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorExternalService`. @see AWSCognitoIdentityGetOpenIdTokenInput @see AWSCognitoIdentityGetOpenIdTokenResponse */ -- (BFTask *)getOpenIdToken:(AWSCognitoIdentityGetOpenIdTokenInput *)request; +- (AWSTask *)getOpenIdToken:(AWSCognitoIdentityGetOpenIdTokenInput *)request; /** -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.
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.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorDeveloperUserAlreadyRegistered`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorDeveloperUserAlreadyRegistered`. @see AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityInput @see AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse */ -- (BFTask *)getOpenIdTokenForDeveloperIdentity:(AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityInput *)request; +- (AWSTask *)getOpenIdTokenForDeveloperIdentity:(AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityInput *)request; /** -Lists the identities in a pool.
+Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the ListIdentities service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityListIdentitiesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityListIdentitiesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityListIdentitiesInput @see AWSCognitoIdentityListIdentitiesResponse */ -- (BFTask *)listIdentities:(AWSCognitoIdentityListIdentitiesInput *)request; +- (AWSTask *)listIdentities:(AWSCognitoIdentityListIdentitiesInput *)request; /** -Lists all of the Cognito identity pools registered for your account.
+Lists all of the Cognito identity pools registered for your account.
This is a public API. You do not need any credentials to call this API.
@param request A container for the necessary parameters to execute the ListIdentityPools service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityListIdentityPoolsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityListIdentityPoolsResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityListIdentityPoolsInput @see AWSCognitoIdentityListIdentityPoolsResponse */ -- (BFTask *)listIdentityPools:(AWSCognitoIdentityListIdentityPoolsInput *)request; +- (AWSTask *)listIdentityPools:(AWSCognitoIdentityListIdentityPoolsInput *)request; /** -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.
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.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the LookupDeveloperIdentity service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityLookupDeveloperIdentityResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityLookupDeveloperIdentityResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityLookupDeveloperIdentityInput @see AWSCognitoIdentityLookupDeveloperIdentityResponse */ -- (BFTask *)lookupDeveloperIdentity:(AWSCognitoIdentityLookupDeveloperIdentityInput *)request; +- (AWSTask *)lookupDeveloperIdentity:(AWSCognitoIdentityLookupDeveloperIdentityInput *)request; /** -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.
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.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the MergeDeveloperIdentities service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityMergeDeveloperIdentitiesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityMergeDeveloperIdentitiesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityMergeDeveloperIdentitiesInput @see AWSCognitoIdentityMergeDeveloperIdentitiesResponse */ -- (BFTask *)mergeDeveloperIdentities:(AWSCognitoIdentityMergeDeveloperIdentitiesInput *)request; +- (AWSTask *)mergeDeveloperIdentities:(AWSCognitoIdentityMergeDeveloperIdentitiesInput *)request; /** - SetIdentityPoolRoles +Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the SetIdentityPoolRoles service method. - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorLimitExceeded`. @see AWSCognitoIdentitySetIdentityPoolRolesInput */ -- (BFTask *)setIdentityPoolRoles:(AWSCognitoIdentitySetIdentityPoolRolesInput *)request; +- (AWSTask *)setIdentityPoolRoles:(AWSCognitoIdentitySetIdentityPoolRolesInput *)request; /** -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 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.
This is a public API. You do not need any credentials to call this API.
@param request A container for the necessary parameters to execute the UnlinkDeveloperIdentity service method. - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. @see AWSCognitoIdentityUnlinkDeveloperIdentityInput */ -- (BFTask *)unlinkDeveloperIdentity:(AWSCognitoIdentityUnlinkDeveloperIdentityInput *)request; +- (AWSTask *)unlinkDeveloperIdentity:(AWSCognitoIdentityUnlinkDeveloperIdentityInput *)request; /** -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.
+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.
This is a public API. You do not need any credentials to call this API.
@param request A container for the necessary parameters to execute the UnlinkIdentity service method. - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorExternalService`. @see AWSCognitoIdentityUnlinkIdentityInput */ -- (BFTask *)unlinkIdentity:(AWSCognitoIdentityUnlinkIdentityInput *)request; +- (AWSTask *)unlinkIdentity:(AWSCognitoIdentityUnlinkIdentityInput *)request; /** -Updates a user pool.
+Updates a user pool.
You must use AWS Developer credentials to call this API.
@param request A container for the necessary parameters to execute the UpdateIdentityPool service method. - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityPool`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domian and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`. + @return An instance of `AWSTask`. On successful execution, `task.result` will contain an instance of `AWSCognitoIdentityIdentityPool`. On failed execution, `task.error` may contain an `NSError` with `AWSCognitoIdentityErrorDomain` domain and the following error code: `AWSCognitoIdentityErrorInvalidParameter`, `AWSCognitoIdentityErrorResourceNotFound`, `AWSCognitoIdentityErrorNotAuthorized`, `AWSCognitoIdentityErrorResourceConflict`, `AWSCognitoIdentityErrorTooManyRequests`, `AWSCognitoIdentityErrorInternalError`, `AWSCognitoIdentityErrorLimitExceeded`. @see AWSCognitoIdentityIdentityPool @see AWSCognitoIdentityIdentityPool */ -- (BFTask *)updateIdentityPool:(AWSCognitoIdentityIdentityPool *)request; +- (AWSTask *)updateIdentityPool:(AWSCognitoIdentityIdentityPool *)request; @end diff --git a/Frameworks/AWSCore.framework/Headers/AWSCore-umbrella.h b/Frameworks/AWSCore.framework/Headers/AWSCore-umbrella.h index 362b82d..d642c23 100644 --- a/Frameworks/AWSCore.framework/Headers/AWSCore-umbrella.h +++ b/Frameworks/AWSCore.framework/Headers/AWSCore-umbrella.h @@ -4,21 +4,31 @@ #import "AWSCredentialsProvider.h" #import "AWSIdentityProvider.h" #import "AWSSignature.h" +#import "AWSBolts.h" +#import "AWSExecutor.h" +#import "AWSTask.h" +#import "AWSTaskCompletionSource.h" #import "AWSCognitoIdentity.h" #import "AWSCognitoIdentityModel.h" +#import "AWSCognitoIdentityResources.h" #import "AWSCognitoIdentityService.h" -#import "AWSMobileAnalytics.h" -#import "AWSMobileAnalyticsAppleMonetizationEventBuilder.h" -#import "AWSMobileAnalyticsConfiguration.h" -#import "AWSMobileAnalyticsEvent.h" -#import "AWSMobileAnalyticsEventClient.h" -#import "AWSMobileAnalyticsMonetizationEventBuilder.h" -#import "AWSMobileAnalyticsOptions.h" -#import "AWSMobileAnalyticsVirtualMonetizationEventBuilder.h" -#import "MobileAnalytics.h" -#import "AWSMobileAnalyticsERS.h" -#import "AWSMobileAnalyticsERSModel.h" -#import "AWSMobileAnalyticsERSService.h" +#import "AWSMantle.h" +#import "AWSMTLJSONAdapter.h" +#import "AWSMTLManagedObjectAdapter.h" +#import "AWSMTLModel+NSCoding.h" +#import "AWSMTLModel.h" +#import "AWSMTLReflection.h" +#import "AWSMTLValueTransformer.h" +#import "AWSEXTKeyPathCoding.h" +#import "AWSEXTRuntimeExtensions.h" +#import "AWSEXTScope.h" +#import "AWSmetamacros.h" +#import "NSArray+AWSMTLManipulationAdditions.h" +#import "NSDictionary+AWSMTLManipulationAdditions.h" +#import "NSError+AWSMTLModelException.h" +#import "NSObject+AWSMTLComparisonAdditions.h" +#import "NSValueTransformer+AWSMTLInversionAdditions.h" +#import "NSValueTransformer+AWSMTLPredefinedTransformerAdditions.h" #import "AWSNetworking.h" #import "AWSURLSessionManager.h" #import "AWSSerialization.h" @@ -31,12 +41,12 @@ #import "AWSServiceEnum.h" #import "AWSSTS.h" #import "AWSSTSModel.h" +#import "AWSSTSResources.h" #import "AWSSTSService.h" #import "AWSCategory.h" #import "AWSLogging.h" #import "AWSModel.h" #import "AWSSynchronizedMutableDictionary.h" -#import "AWSXMLWriter.h" FOUNDATION_EXPORT double AWSCoreVersionNumber; FOUNDATION_EXPORT const unsigned char AWSCoreVersionString[]; diff --git a/Frameworks/AWSCore.framework/Headers/AWSCore.h b/Frameworks/AWSCore.framework/Headers/AWSCore.h index 55173d9..46a4911 100644 --- a/Frameworks/AWSCore.framework/Headers/AWSCore.h +++ b/Frameworks/AWSCore.framework/Headers/AWSCore.h @@ -27,6 +27,5 @@ #import "AWSSTS.h" #import "AWSCognitoIdentity.h" -#import "MobileAnalytics.h" -#import- * The example below demonstrates how to record view and conversion events. The \@"level1Complete" event represents the view event, - * and if the user makes a purchase, the code below records a \@"level1UserBoughtUpgrade" event as the conversion event. - *
- * - * @code - * // get the event client from insights instance - * idReturns 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:
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.
For mobile applications, we recommend that you use Amazon Cognito. You can Amazon Cognito with the AWS SDK for iOS and the AWS SDK for Android to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application.
To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.
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:
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:
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.
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).
We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.
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.
Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.
Next, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.
If you want to use Amazon Cognito in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
", - "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"}, - "output":{ - "shape":"IdentityDescription", - "documentation":"A description of the identity." - }, - "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." - } - ] - }, - "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"}, - "output":{"shape":"GetCredentialsForIdentityResponse"}, - "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":"InvalidIdentityPoolConfigurationException", - "error":{"httpStatusCode":400}, - "exception":true - }, - { - "shape":"InternalErrorException", - "exception":true, - "fault":true, - "documentation":"Thrown when the service encounters an error during processing the request." - } - ] - }, - "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"}, - "output":{"shape":"GetIdentityPoolRolesResponse"}, - "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." - } - ] - }, - "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 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"}, - "SecretKey":{"shape":"SecretKeyString"}, - "SessionToken":{"shape":"SessionTokenString"}, - "Expiration":{"shape":"DateType"} - } - }, - "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"} - } - }, - "DescribeIdentityPoolInput":{ - "type":"structure", - "required":["IdentityPoolId"], - "members":{ - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - } - }, - "documentation":"Input to the DescribeIdentityPool action." - }, - "DeveloperProviderName":{ - "type":"string", - "min":1, - "max":128, - "pattern":"[\\w._-]+" - }, - "DeveloperUserAlreadyRegisteredException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"String", - "documentation":"This developer user identifier is already registered with Cognito.
" - } - }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The provided developer user identifier is already registered with Cognito under a different identity ID.
" - }, - "DeveloperUserIdentifier":{ - "type":"string", - "min":1, - "max":1024, - "pattern":"[\\w.@_-]+" - }, - "DeveloperUserIdentifierList":{ - "type":"list", - "member":{"shape":"DeveloperUserIdentifier"} - }, - "GetCredentialsForIdentityInput":{ - "type":"structure", - "required":["IdentityId"], - "members":{ - "IdentityId":{"shape":"IdentityId"}, - "Logins":{"shape":"LoginsMap"} - } - }, - "GetCredentialsForIdentityResponse":{ - "type":"structure", - "members":{ - "IdentityId":{"shape":"IdentityId"}, - "Credentials":{"shape":"Credentials"} - } - }, - "GetIdInput":{ - "type":"structure", - "required":["IdentityPoolId"], - "members":{ - "AccountId":{ - "shape":"AccountId", - "documentation":"A standard AWS account ID (9+ digits)." - }, - "IdentityPoolId":{ - "shape":"IdentityPoolId", - "documentation":"An identity pool ID in the format REGION:GUID." - }, - "Logins":{ - "shape":"LoginsMap", - "documentation":"A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
graph.facebook.com accounts.google.com www.amazon.com 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.
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"} - }, - "error":{"httpStatusCode":400}, - "exception":true - }, - "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.
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.
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.
For mobile applications, we recommend that you use Amazon Cognito. You can Amazon Cognito with the AWS SDK for iOS and the AWS SDK for Android to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application.
To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.
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).
We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.
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.
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/Frameworks/AWSDynamoDB.framework/AWSDynamoDB b/Frameworks/AWSDynamoDB.framework/AWSDynamoDB deleted file mode 100755 index 6dd43c7..0000000 Binary files a/Frameworks/AWSDynamoDB.framework/AWSDynamoDB and /dev/null differ diff --git a/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDB-umbrella.h b/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDB-umbrella.h deleted file mode 100644 index c5ffd90..0000000 --- a/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDB-umbrella.h +++ /dev/null @@ -1,10 +0,0 @@ -#importRepresents an attribute for describing the key schema for the table and indexes.
- Required parameters: [AttributeName, AttributeType] - */ -@interface AWSDynamoDBAttributeDefinition : AWSModel - - -/** -A name for the attribute.
- */ -@property (nonatomic, strong) NSString *attributeName; - -/** -The data type for the attribute.
- */ -@property (nonatomic, assign) AWSDynamoDBScalarAttributeType attributeType; - -@end - -/** -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.
- */ -@interface AWSDynamoDBAttributeValue : AWSModel - - -/** -A Binary data type.
- */ -@property (nonatomic, strong) NSData *B; - -/** -A Boolean data type.
- */ -@property (nonatomic, strong) NSNumber *BOOLEAN; - -/** -A Binary Set data type.
- */ -@property (nonatomic, strong) NSArray *BS; - -/** -A List of attribute values.
- */ -@property (nonatomic, strong) NSArray *L; - -/** -A Map of attribute values.
- */ -@property (nonatomic, strong) NSDictionary *M; - -/** -A Number data type.
- */ -@property (nonatomic, strong) NSString *N; - -/** -A Null data type.
- */ -@property (nonatomic, strong) NSNumber *NIL; - -/** -A Number Set data type.
- */ -@property (nonatomic, strong) NSArray *NS; - -/** -A String data type.
- */ -@property (nonatomic, strong) NSString *S; - -/** -A String Set data type.
- */ -@property (nonatomic, strong) NSArray *SS; - -@end - -/** -For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.
You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.
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.
- */ -@interface AWSDynamoDBAttributeValueUpdate : AWSModel - - -/** -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 you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
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.
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.
- */ -@property (nonatomic, strong) AWSDynamoDBAttributeValue *value; - -@end - -/** -Represents the input of a BatchGetItem operation.
- Required parameters: [RequestItems] - */ -@interface AWSDynamoDBBatchGetItemInput : AWSRequest - - -/** -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.
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.
Represents the output of a BatchGetItem operation.
- */ -@interface AWSDynamoDBBatchGetItemOutput : AWSModel - - -/** -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.
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.
- */ -@property (nonatomic, strong) NSDictionary *responses; - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *unprocessedKeys; - -@end - -/** -Represents the input of a BatchWriteItem operation.
- Required parameters: [RequestItems] - */ -@interface AWSDynamoDBBatchWriteItemInput : AWSRequest - - -/** -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 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.
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 output of a BatchWriteItem operation.
- */ -@interface AWSDynamoDBBatchWriteItemOutput : AWSModel - - -/** -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.
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.
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.
- */ -@property (nonatomic, strong) NSDictionary *unprocessedItems; - -@end - -/** -Represents the amount of provisioned throughput capacity consumed on a table or an index.
- */ -@interface AWSDynamoDBCapacity : AWSModel - - -/** -The total number of capacity units consumed on a table or an index.
- */ -@property (nonatomic, strong) NSNumber *capacityUnits; - -@end - -/** -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.
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.
- */ -@property (nonatomic, strong) NSArray *attributeValueList; - -/** -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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
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.
- */ -@property (nonatomic, assign) AWSDynamoDBComparisonOperator comparisonOperator; - -@end - -/** -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.
- */ -@interface AWSDynamoDBConsumedCapacity : AWSModel - - -/** -The total number of capacity units consumed by the operation.
- */ -@property (nonatomic, strong) NSNumber *capacityUnits; - -/** -The amount of throughput consumed on each global index affected by the operation.
- */ -@property (nonatomic, strong) NSDictionary *globalSecondaryIndexes; - -/** -The amount of throughput consumed on each local index affected by the operation.
- */ -@property (nonatomic, strong) NSDictionary *localSecondaryIndexes; - -/** -The amount of throughput consumed on the table affected by the operation.
- */ -@property (nonatomic, strong) AWSDynamoDBCapacity *table; - -/** -The name of the table that was affected by the operation.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the input of a CreateTable operation.
- Required parameters: [AttributeDefinitions, TableName, KeySchema, ProvisionedThroughput] - */ -@interface AWSDynamoDBCreateTableInput : AWSRequest - - -/** -An array of attributes that describe the key schema for the table and indexes.
- */ -@property (nonatomic, strong) NSArray *attributeDefinitions; - -/** -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.
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.
- */ -@property (nonatomic, strong) NSArray *keySchema; - -/** -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.
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.
- */ -@property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *provisionedThroughput; - -/** -The name of the table to create.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a CreateTable operation.
- */ -@interface AWSDynamoDBCreateTableOutput : AWSModel - - -/** -Represents the properties of a table.
- */ -@property (nonatomic, strong) AWSDynamoDBTableDescription *tableDescription; - -@end - -/** -Represents the input of a DeleteItem operation.
- Required parameters: [TableName, Key] - */ -@interface AWSDynamoDBDeleteItemInput : AWSRequest - - -/** -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
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.
- */ -@property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; - -/** -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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
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.
- */ -@property (nonatomic, strong) NSDictionary *expected; - -/** -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)
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.
- */ -@property (nonatomic, strong) NSDictionary *key; - -/** -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.
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.
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.
The name of the table from which to delete the item.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a DeleteItem operation.
- */ -@interface AWSDynamoDBDeleteItemOutput : AWSModel - - -/** -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.
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.
- */ -@property (nonatomic, strong) AWSDynamoDBConsumedCapacity *consumedCapacity; - -/** -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 a request to perform a DeleteItem operation on an item.
- Required parameters: [Key] - */ -@interface AWSDynamoDBDeleteRequest : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *key; - -@end - -/** -Represents the input of a DeleteTable operation.
- Required parameters: [TableName] - */ -@interface AWSDynamoDBDeleteTableInput : AWSRequest - - -/** -The name of the table to delete.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a DeleteTable operation.
- */ -@interface AWSDynamoDBDeleteTableOutput : AWSModel - - -/** -Represents the properties of a table.
- */ -@property (nonatomic, strong) AWSDynamoDBTableDescription *tableDescription; - -@end - -/** -Represents the input of a DescribeTable operation.
- Required parameters: [TableName] - */ -@interface AWSDynamoDBDescribeTableInput : AWSRequest - - -/** -The name of the table to describe.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a DescribeTable operation.
- */ -@interface AWSDynamoDBDescribeTableOutput : AWSModel - - -/** -Represents the properties of a table.
- */ -@property (nonatomic, strong) AWSDynamoDBTableDescription *table; - -@end - -/** -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.
- */ -@interface AWSDynamoDBExpectedAttributeValue : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *attributeValueList; - -/** -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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
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"]}
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.)
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.
- */ -@property (nonatomic, strong) AWSDynamoDBAttributeValue *value; - -@end - -/** -Represents the input of a GetItem operation.
- Required parameters: [TableName, Key] - */ -@interface AWSDynamoDBGetItemInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *attributesToGet; - -/** -A value that if set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.
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"
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.
- */ -@property (nonatomic, strong) NSDictionary *key; - -/** -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.
- */ -@property (nonatomic, strong) NSString *projectionExpression; - -/** -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 item.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a GetItem operation.
- */ -@interface AWSDynamoDBGetItemOutput : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBConsumedCapacity *consumedCapacity; - -/** -A map of attribute names to AttributeValue objects, as specified by AttributesToGet.
- */ -@property (nonatomic, strong) NSDictionary *item; - -@end - -/** -Represents a global secondary index.
- Required parameters: [IndexName, KeySchema, Projection, ProvisionedThroughput] - */ -@interface AWSDynamoDBGlobalSecondaryIndex : AWSModel - - -/** -The name of the global secondary index. The name must be unique among all other indexes on this table.
- */ -@property (nonatomic, strong) NSString *indexName; - -/** -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 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.
- */ -@property (nonatomic, strong) AWSDynamoDBProjection *projection; - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *provisionedThroughput; - -@end - -/** -Represents the properties of a global secondary index.
- */ -@interface AWSDynamoDBGlobalSecondaryIndexDescription : AWSModel - - -/** -The name of the global secondary index.
- */ -@property (nonatomic, strong) NSString *indexName; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *indexSizeBytes; - -/** -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 number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
- */ -@property (nonatomic, strong) NSNumber *itemCount; - -/** -The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
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.
- */ -@property (nonatomic, strong) AWSDynamoDBProjection *projection; - -/** -Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
- */ -@property (nonatomic, strong) AWSDynamoDBProvisionedThroughputDescription *provisionedThroughput; - -@end - -/** -Represents the new provisioned throughput settings to apply to a global secondary index.
- */ -@interface AWSDynamoDBGlobalSecondaryIndexUpdate : AWSModel - - -/** -The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.
- */ -@property (nonatomic, strong) AWSDynamoDBUpdateGlobalSecondaryIndexAction *update; - -@end - -/** -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.
- */ -@interface AWSDynamoDBItemCollectionMetrics : AWSModel - - -/** -The hash key value of the item collection. This value is the same as the hash key of the item.
- */ -@property (nonatomic, strong) NSDictionary *itemCollectionKey; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *sizeEstimateRangeGB; - -@end - -/** -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.
- Required parameters: [AttributeName, KeyType] - */ -@interface AWSDynamoDBKeySchemaElement : AWSModel - - -/** -The name of a key attribute.
- */ -@property (nonatomic, strong) NSString *attributeName; - -/** -The attribute data, consisting of the data type and the attribute value itself.
- */ -@property (nonatomic, assign) AWSDynamoDBKeyType keyType; - -@end - -/** -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.
- Required parameters: [Keys] - */ -@interface AWSDynamoDBKeysAndAttributes : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *attributesToGet; - -/** -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 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"
The primary key attribute values that define the items and the attributes associated with the items.
- */ -@property (nonatomic, strong) NSArray *keys; - -/** -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.
- */ -@property (nonatomic, strong) NSString *projectionExpression; - -@end - -/** -Represents the input of a ListTables operation.
- */ -@interface AWSDynamoDBListTablesInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *exclusiveStartTableName; - -/** -A maximum number of table names to return. If this parameter is not specified, the limit is 100.
- */ -@property (nonatomic, strong) NSNumber *limit; - -@end - -/** -Represents the output of a ListTables operation.
- */ -@interface AWSDynamoDBListTablesOutput : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *lastEvaluatedTableName; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *tableNames; - -@end - -/** -Represents a local secondary index.
- Required parameters: [IndexName, KeySchema, Projection] - */ -@interface AWSDynamoDBLocalSecondaryIndex : AWSModel - - -/** -The name of the local secondary index. The name must be unique among all other indexes on this table.
- */ -@property (nonatomic, strong) NSString *indexName; - -/** -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 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.
- */ -@property (nonatomic, strong) AWSDynamoDBProjection *projection; - -@end - -/** -Represents the properties of a local secondary index.
- */ -@interface AWSDynamoDBLocalSecondaryIndexDescription : AWSModel - - -/** -Represents the name of the local secondary index.
- */ -@property (nonatomic, strong) NSString *indexName; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *indexSizeBytes; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *itemCount; - -/** -The complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
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.
- */ -@property (nonatomic, strong) AWSDynamoDBProjection *projection; - -@end - -/** -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.
- */ -@interface AWSDynamoDBProjection : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *nonKeyAttributes; - -/** -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 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.
- Required parameters: [ReadCapacityUnits, WriteCapacityUnits] - */ -@interface AWSDynamoDBProvisionedThroughput : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *readCapacityUnits; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *writeCapacityUnits; - -@end - -/** -Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
- */ -@interface AWSDynamoDBProvisionedThroughputDescription : AWSModel - - -/** -The date and time of the last provisioned throughput decrease for this table.
- */ -@property (nonatomic, strong) NSDate *lastDecreaseDateTime; - -/** -The date and time of the last provisioned throughput increase for this table.
- */ -@property (nonatomic, strong) NSDate *lastIncreaseDateTime; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *numberOfDecreasesToday; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *readCapacityUnits; - -/** -The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
- */ -@property (nonatomic, strong) NSNumber *writeCapacityUnits; - -@end - -/** -Represents the input of a PutItem operation.
- Required parameters: [TableName, Item] - */ -@interface AWSDynamoDBPutItemInput : AWSRequest - - -/** -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
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.
- */ -@property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; - -/** -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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
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.
- */ -@property (nonatomic, strong) NSDictionary *expected; - -/** -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)
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.
- */ -@property (nonatomic, strong) NSDictionary *item; - -/** -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.
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.
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.
The name of the table to contain the item.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a PutItem operation.
- */ -@interface AWSDynamoDBPutItemOutput : AWSModel - - -/** -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.
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.
- */ -@property (nonatomic, strong) AWSDynamoDBConsumedCapacity *consumedCapacity; - -/** -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 a request to perform a PutItem operation on an item.
- Required parameters: [Item] - */ -@interface AWSDynamoDBPutRequest : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *item; - -@end - -/** -Represents the input of a Query operation.
- Required parameters: [TableName, KeyConditions] - */ -@interface AWSDynamoDBQueryInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *attributesToGet; - -/** -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.
- */ -@property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; - -/** -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 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.
- */ -@property (nonatomic, strong) NSDictionary *exclusiveStartKey; - -/** -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)
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.
- */ -@property (nonatomic, strong) NSString *filterExpression; - -/** -The name of an index to query. This index can be any local secondary index or global secondary index on the table.
- */ -@property (nonatomic, strong) NSString *indexName; - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *keyConditions; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *limit; - -/** -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.
- */ -@property (nonatomic, strong) NSString *projectionExpression; - -/** -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.)
QueryFilter does not allow key attrbutes. You cannot define a filter condition on a hash key or range key.
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.
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.
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.
- */ -@property (nonatomic, strong) NSNumber *scanIndexForward; - -/** -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.)
The name of the table containing the requested items.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of a Query operation.
- */ -@interface AWSDynamoDBQueryOutput : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBConsumedCapacity *consumedCapacity; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *count; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *items; - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *lastEvaluatedKey; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *scannedCount; - -@end - -/** -Represents the input of a Scan operation.
- Required parameters: [TableName] - */ -@interface AWSDynamoDBScanInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *attributesToGet; - -/** -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.
- */ -@property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *exclusiveStartKey; - -/** -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)
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.
- */ -@property (nonatomic, strong) NSString *filterExpression; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *limit; - -/** -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.
- */ -@property (nonatomic, strong) NSString *projectionExpression; - -/** -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.
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.
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.
- */ -@property (nonatomic, strong) NSNumber *segment; - -/** -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.)
The name of the table containing the requested items.
- */ -@property (nonatomic, strong) NSString *tableName; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *totalSegments; - -@end - -/** -Represents the output of a Scan operation.
- */ -@interface AWSDynamoDBScanOutput : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBConsumedCapacity *consumedCapacity; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *count; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *items; - -/** -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.
- */ -@property (nonatomic, strong) NSDictionary *lastEvaluatedKey; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *scannedCount; - -@end - -/** -Represents the properties of a table.
- */ -@interface AWSDynamoDBTableDescription : AWSModel - - -/** -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 date and time when the table was created, in UNIX epoch time format.
- */ -@property (nonatomic, strong) NSDate *creationDateTime; - -/** -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.
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.
- */ -@property (nonatomic, strong) NSNumber *itemCount; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *keySchema; - -/** -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 provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
- */ -@property (nonatomic, strong) AWSDynamoDBProvisionedThroughputDescription *provisionedThroughput; - -/** -The name of the table.
- */ -@property (nonatomic, strong) NSString *tableName; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *tableSizeBytes; - -/** -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.
Represents the new provisioned throughput settings to be applied to a global secondary index.
- Required parameters: [IndexName, ProvisionedThroughput] - */ -@interface AWSDynamoDBUpdateGlobalSecondaryIndexAction : AWSModel - - -/** -The name of the global secondary index to be updated.
- */ -@property (nonatomic, strong) NSString *indexName; - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *provisionedThroughput; - -@end - -/** -Represents the input of an UpdateItem operation.
- Required parameters: [TableName, Key] - */ -@interface AWSDynamoDBUpdateItemInput : AWSRequest - - -/** -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 you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
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.
- */ -@property (nonatomic, strong) NSDictionary *attributeUpdates; - -/** -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
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.
- */ -@property (nonatomic, assign) AWSDynamoDBConditionalOperator conditionalOperator; - -/** -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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
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.
- */ -@property (nonatomic, strong) NSDictionary *expected; - -/** -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)
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.
- */ -@property (nonatomic, strong) NSDictionary *key; - -/** -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.
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.
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.
The name of the table containing the item to update.
- */ -@property (nonatomic, strong) NSString *tableName; - -/** -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 you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
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
Represents the output of an UpdateItem operation.
- */ -@interface AWSDynamoDBUpdateItemOutput : AWSModel - - -/** -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.
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.
- */ -@property (nonatomic, strong) AWSDynamoDBConsumedCapacity *consumedCapacity; - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBItemCollectionMetrics *itemCollectionMetrics; - -@end - -/** -Represents the input of an UpdateTable operation.
- Required parameters: [TableName] - */ -@interface AWSDynamoDBUpdateTableInput : AWSRequest - - -/** -An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.
- */ -@property (nonatomic, strong) NSArray *globalSecondaryIndexUpdates; - -/** -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.
- */ -@property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *provisionedThroughput; - -/** -The name of the table to be updated.
- */ -@property (nonatomic, strong) NSString *tableName; - -@end - -/** -Represents the output of an UpdateTable operation.
- */ -@interface AWSDynamoDBUpdateTableOutput : AWSModel - - -/** -Represents the properties of a table.
- */ -@property (nonatomic, strong) AWSDynamoDBTableDescription *tableDescription; - -@end - -/** -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.
- */ -@interface AWSDynamoDBWriteRequest : AWSModel - - -/** -A request to perform a DeleteItem operation.
- */ -@property (nonatomic, strong) AWSDynamoDBDeleteRequest *deleteRequest; - -/** -A request to perform a PutItem operation.
- */ -@property (nonatomic, strong) AWSDynamoDBPutRequest *putRequest; - -@end diff --git a/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDBObjectMapper.h b/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDBObjectMapper.h deleted file mode 100644 index d45c72f..0000000 --- a/Frameworks/AWSDynamoDB.framework/Headers/AWSDynamoDBObjectMapper.h +++ /dev/null @@ -1,524 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importThis 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.
- */ -@interface AWSDynamoDB : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let DynamoDB = AWSDynamoDB.defaultDynamoDB() - - *Objective-C* - - AWSDynamoDB *DynamoDB = [AWSDynamoDB defaultDynamoDB]; - - @return The default service client. - */ -+ (instancetype)defaultDynamoDB; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSDynamoDB.registerDynamoDBWithConfiguration(configuration, forKey: "USWest2DynamoDB") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSDynamoDB registerDynamoDBWithConfiguration:configuration forKey:@"USWest2DynamoDB"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let DynamoDB = AWSDynamoDB(forKey: "USWest2DynamoDB") - - *Objective-C* - - AWSDynamoDB *DynamoDB = [AWSDynamoDB DynamoDBForKey:@"USWest2DynamoDB"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerDynamoDBWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerDynamoDBWithConfiguration:forKey:` before invoking this method. If `+ registerDynamoDBWithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSDynamoDB.registerDynamoDBWithConfiguration(configuration, forKey: "USWest2DynamoDB") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSDynamoDB registerDynamoDBWithConfiguration:configuration forKey:@"USWest2DynamoDB"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let DynamoDB = AWSDynamoDB(forKey: "USWest2DynamoDB") - - *Objective-C* - - AWSDynamoDB *DynamoDB = [AWSDynamoDB DynamoDBForKey:@"USWest2DynamoDB"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)DynamoDBForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeDynamoDBForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerDynamoDBWithConfiguration:forKey:` and `+ DynamoDBForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerDynamoDBWithConfiguration:forKey:' and '+ DynamoDBForKey:' instead."))); - -/** -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.
- - @param request A container for the necessary parameters to execute the BatchGetItem service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBBatchGetItemOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorProvisionedThroughputExceeded`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBBatchGetItemInput - @see AWSDynamoDBBatchGetItemOutput - */ -- (BFTask *)batchGetItem:(AWSDynamoDBBatchGetItemInput *)request; - -/** -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.
BatchWriteItem cannot update items. To update items, use the UpdateItem API.
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.
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.
- - @param request A container for the necessary parameters to execute the CreateTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBCreateTableOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorResourceInUse`, `AWSDynamoDBErrorLimitExceeded`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBCreateTableInput - @see AWSDynamoDBCreateTableOutput - */ -- (BFTask *)createTable:(AWSDynamoDBCreateTableInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteItem service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBDeleteItemOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorConditionalCheckFailed`, `AWSDynamoDBErrorProvisionedThroughputExceeded`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorItemCollectionSizeLimitExceeded`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBDeleteItemInput - @see AWSDynamoDBDeleteItemOutput - */ -- (BFTask *)deleteItem:(AWSDynamoDBDeleteItemInput *)request; - -/** -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.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
Use the DescribeTable API to check the status of the table.
- - @param request A container for the necessary parameters to execute the DeleteTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBDeleteTableOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorResourceInUse`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorLimitExceeded`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBDeleteTableInput - @see AWSDynamoDBDeleteTableOutput - */ -- (BFTask *)deleteTable:(AWSDynamoDBDeleteTableInput *)request; - -/** -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.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
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.
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.
- - @param request A container for the necessary parameters to execute the ListTables service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBListTablesOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBListTablesInput - @see AWSDynamoDBListTablesOutput - */ -- (BFTask *)listTables:(AWSDynamoDBListTablesInput *)request; - -/** -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.
To prevent a new item from replacing an existing item, use a conditional put operation with ComparisonOperator set to NULL for the primary key attribute, or attributes.
For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.
- - @param request A container for the necessary parameters to execute the PutItem service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBPutItemOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorConditionalCheckFailed`, `AWSDynamoDBErrorProvisionedThroughputExceeded`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorItemCollectionSizeLimitExceeded`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBPutItemInput - @see AWSDynamoDBPutItemOutput - */ -- (BFTask *)putItem:(AWSDynamoDBPutItemInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the Query service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBQueryOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorProvisionedThroughputExceeded`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBQueryInput - @see AWSDynamoDBQueryOutput - */ -- (BFTask *)query:(AWSDynamoDBQueryInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the Scan service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBScanOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorProvisionedThroughputExceeded`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBScanInput - @see AWSDynamoDBScanOutput - */ -- (BFTask *)scan:(AWSDynamoDBScanInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the UpdateItem service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBUpdateItemOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorConditionalCheckFailed`, `AWSDynamoDBErrorProvisionedThroughputExceeded`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorItemCollectionSizeLimitExceeded`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBUpdateItemInput - @see AWSDynamoDBUpdateItemOutput - */ -- (BFTask *)updateItem:(AWSDynamoDBUpdateItemInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the UpdateTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSDynamoDBUpdateTableOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSDynamoDBErrorDomain` domian and the following error code: `AWSDynamoDBErrorResourceInUse`, `AWSDynamoDBErrorResourceNotFound`, `AWSDynamoDBErrorLimitExceeded`, `AWSDynamoDBErrorInternalServer`. - - @see AWSDynamoDBUpdateTableInput - @see AWSDynamoDBUpdateTableOutput - */ -- (BFTask *)updateTable:(AWSDynamoDBUpdateTableInput *)request; - -@end diff --git a/Frameworks/AWSDynamoDB.framework/Info.plist b/Frameworks/AWSDynamoDB.framework/Info.plist deleted file mode 100644 index 0909a10..0000000 Binary files a/Frameworks/AWSDynamoDB.framework/Info.plist and /dev/null differ diff --git a/Frameworks/AWSDynamoDB.framework/Modules/module.modulemap b/Frameworks/AWSDynamoDB.framework/Modules/module.modulemap deleted file mode 100644 index 437507e..0000000 --- a/Frameworks/AWSDynamoDB.framework/Modules/module.modulemap +++ /dev/null @@ -1,6 +0,0 @@ -framework module AWSDynamoDB { - umbrella header "AWSDynamoDB-umbrella.h" - - export * - module * { export * } -} diff --git a/Frameworks/AWSDynamoDB.framework/_CodeSignature/CodeResources b/Frameworks/AWSDynamoDB.framework/_CodeSignature/CodeResources deleted file mode 100644 index 52e7c43..0000000 --- a/Frameworks/AWSDynamoDB.framework/_CodeSignature/CodeResources +++ /dev/null @@ -1,167 +0,0 @@ - - -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.
BatchWriteItem cannot update items. To update items, use the UpdateItem API.
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.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
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.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
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.
To prevent a new item from replacing an existing item, use a conditional put operation with ComparisonOperator set to NULL for the primary key attribute, or attributes.
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 you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
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.
You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.
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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
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.)
QueryFilter does not allow key attrbutes. You cannot define a filter condition on a hash key or range key.
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 you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute, with a value of 3.
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.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.
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 you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
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/Frameworks/AWSEC2.framework/AWSEC2 b/Frameworks/AWSEC2.framework/AWSEC2 deleted file mode 100755 index a5d2687..0000000 Binary files a/Frameworks/AWSEC2.framework/AWSEC2 and /dev/null differ diff --git a/Frameworks/AWSEC2.framework/Headers/AWSEC2-umbrella.h b/Frameworks/AWSEC2.framework/Headers/AWSEC2-umbrella.h deleted file mode 100644 index 7a4b877..0000000 --- a/Frameworks/AWSEC2.framework/Headers/AWSEC2-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#importThe ID of the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** - - */ -@interface AWSEC2AcceptVpcPeeringConnectionResult : AWSModel - - -/** -Information about the VPC peering connection.
- */ -@property (nonatomic, strong) AWSEC2VpcPeeringConnection *vpcPeeringConnection; - -@end - -/** -Describes an account attribute.
- */ -@interface AWSEC2AccountAttribute : AWSModel - - -/** -The name of the account attribute.
- */ -@property (nonatomic, strong) NSString *attributeName; - -/** -One or more values for the account attribute.
- */ -@property (nonatomic, strong) NSArray *attributeValues; - -@end - -/** -Describes a value of an account attribute.
- */ -@interface AWSEC2AccountAttributeValue : AWSModel - - -/** -The value of the attribute.
- */ -@property (nonatomic, strong) NSString *attributeValue; - -@end - -/** -Describes an Elastic IP address.
- */ -@interface AWSEC2Address : AWSModel - - -/** -The ID representing the allocation of the address for use with EC2-VPC.
- */ -@property (nonatomic, strong) NSString *allocationId; - -/** -The ID representing the association of the address with an instance in a VPC.
- */ -@property (nonatomic, strong) NSString *associationId; - -/** -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 instance the address is associated with (if any).
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The ID of the AWS account that owns the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceOwnerId; - -/** -The private IP address associated with the Elastic IP address.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -The Elastic IP address.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** - - */ -@interface AWSEC2AllocateAddressRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, assign) AWSEC2DomainType domain; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2AllocateAddressResult : AWSModel - - -/** -[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
- */ -@property (nonatomic, strong) NSString *allocationId; - -/** -Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
The Elastic IP address.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** - - */ -@interface AWSEC2AssignPrivateIpAddressesRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *allowReassignment; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *privateIpAddresses; - -/** -The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
- */ -@property (nonatomic, strong) NSNumber *secondaryPrivateIpAddressCount; - -@end - -/** - - */ -@interface AWSEC2AssociateAddressRequest : AWSRequest - - -/** -[EC2-VPC] The allocation ID. This is required for EC2-VPC.
- */ -@property (nonatomic, strong) NSString *allocationId; - -/** -[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
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.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -[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.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -The Elastic IP address. This is required for EC2-Classic.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** - - */ -@interface AWSEC2AssociateAddressResult : AWSModel - - -/** -[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
- */ -@property (nonatomic, strong) NSString *associationId; - -@end - -/** - - */ -@interface AWSEC2AssociateDhcpOptionsRequest : AWSRequest - - -/** -The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2AssociateRouteTableRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** - - */ -@interface AWSEC2AssociateRouteTableResult : AWSModel - - -/** -The route table association ID (needed to disassociate the route table).
- */ -@property (nonatomic, strong) NSString *associationId; - -@end - -/** - - */ -@interface AWSEC2AttachInternetGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Internet gateway.
- */ -@property (nonatomic, strong) NSString *internetGatewayId; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2AttachNetworkInterfaceRequest : AWSRequest - - -/** -The index of the device for the network interface attachment.
- */ -@property (nonatomic, strong) NSNumber *deviceIndex; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -@end - -/** - - */ -@interface AWSEC2AttachNetworkInterfaceResult : AWSModel - - -/** -The ID of the network interface attachment.
- */ -@property (nonatomic, strong) NSString *attachmentId; - -@end - -/** - - */ -@interface AWSEC2AttachVolumeRequest : AWSRequest - - -/** -The device name to expose to the instance (for example, /dev/sdh or xvdh).
The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2AttachVpnGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -/** -The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *vpnGatewayId; - -@end - -/** - - */ -@interface AWSEC2AttachVpnGatewayResult : AWSModel - - -/** -Information about the attachment.
- */ -@property (nonatomic, strong) AWSEC2VpcAttachment *vpcAttachment; - -@end - -/** -The value to use when a resource attribute accepts a Boolean value.
- */ -@interface AWSEC2AttributeBooleanValue : AWSModel - - -/** -Valid values are true or false.
The value to use for a resource attribute.
- */ -@interface AWSEC2AttributeValue : AWSModel - - -/** -Valid values are case-sensitive and vary by action.
- */ -@property (nonatomic, strong) NSString *value; - -@end - -/** - - */ -@interface AWSEC2AuthorizeSecurityGroupEgressRequest : AWSRequest - - -/** -The CIDR IP address range. You can't specify this parameter when specifying a source security group.
- */ -@property (nonatomic, strong) NSString *cidrIp; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSArray *ipPermissions; - -/** -The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
[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.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupName; - -/** -The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupOwnerId; - -/** -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.
- */ -@property (nonatomic, strong) NSString *cidrIp; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -[EC2-Classic, default VPC] The name of the security group.
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSArray *ipPermissions; - -/** -The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
[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.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupName; - -/** -The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupOwnerId; - -/** -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.
Describes an Availability Zone.
- */ -@interface AWSEC2AvailabilityZone : AWSModel - - -/** -Any messages about the Availability Zone.
- */ -@property (nonatomic, strong) NSArray *messages; - -/** -The name of the region.
- */ -@property (nonatomic, strong) NSString *regionName; - -/** -The state of the Availability Zone (available | impaired | unavailable).
The name of the Availability Zone.
- */ -@property (nonatomic, strong) NSString *zoneName; - -@end - -/** -Describes a message about an Availability Zone.
- */ -@interface AWSEC2AvailabilityZoneMessage : AWSModel - - -/** -The message about the Availability Zone.
- */ -@property (nonatomic, strong) NSString *message; - -@end - -/** - - */ -@interface AWSEC2BlobAttributeValue : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSData *value; - -@end - -/** -Describes a block device mapping.
- */ -@interface AWSEC2BlockDeviceMapping : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2EbsBlockDevice *ebs; - -/** -Suppresses the specified device included in the block device mapping of the AMI.
- */ -@property (nonatomic, strong) NSString *noDevice; - -/** -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.
- */ -@property (nonatomic, strong) NSString *virtualName; - -@end - -/** - - */ -@interface AWSEC2BundleInstanceRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance to bundle.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2Storage *storage; - -@end - -/** - - */ -@interface AWSEC2BundleInstanceResult : AWSModel - - -/** -Information about the bundle task.
- */ -@property (nonatomic, strong) AWSEC2BundleTask *bundleTask; - -@end - -/** -Describes a bundle task.
- */ -@interface AWSEC2BundleTask : AWSModel - - -/** -The ID for this bundle task.
- */ -@property (nonatomic, strong) NSString *bundleId; - -/** -If the task fails, a description of the error.
- */ -@property (nonatomic, strong) AWSEC2BundleTaskError *bundleTaskError; - -/** -The ID of the instance associated with this bundle task.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The level of task completion, as a percent (for example, 20%).
- */ -@property (nonatomic, strong) NSString *progress; - -/** -The time this task started.
- */ -@property (nonatomic, strong) NSDate *startTime; - -/** -The state of the task.
- */ -@property (nonatomic, assign) AWSEC2BundleTaskState state; - -/** -The Amazon S3 storage locations.
- */ -@property (nonatomic, strong) AWSEC2Storage *storage; - -/** -The time of the most recent update for the task.
- */ -@property (nonatomic, strong) NSDate *updateTime; - -@end - -/** -Describes an error for BundleInstance.
- */ -@interface AWSEC2BundleTaskError : AWSModel - - -/** -The error code.
- */ -@property (nonatomic, strong) NSString *code; - -/** -The error message.
- */ -@property (nonatomic, strong) NSString *message; - -@end - -/** - - */ -@interface AWSEC2CancelBundleTaskRequest : AWSRequest - - -/** -The ID of the bundle task.
- */ -@property (nonatomic, strong) NSString *bundleId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2CancelBundleTaskResult : AWSModel - - -/** -The bundle task.
- */ -@property (nonatomic, strong) AWSEC2BundleTask *bundleTask; - -@end - -/** - - */ -@interface AWSEC2CancelConversionRequest : AWSRequest - - -/** -The ID of the conversion task.
- */ -@property (nonatomic, strong) NSString *conversionTaskId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** - - */ -@property (nonatomic, strong) NSString *reasonMessage; - -@end - -/** - - */ -@interface AWSEC2CancelExportTaskRequest : AWSRequest - - -/** -The ID of the export task. This is the ID returned by CreateInstanceExportTask.
The ID of the Reserved Instance listing.
- */ -@property (nonatomic, strong) NSString *reservedInstancesListingId; - -@end - -/** - - */ -@interface AWSEC2CancelReservedInstancesListingResult : AWSModel - - -/** -The Reserved Instance listing.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesListings; - -@end - -/** - - */ -@interface AWSEC2CancelSpotInstanceRequestsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more Spot Instance request IDs.
- */ -@property (nonatomic, strong) NSArray *spotInstanceRequestIds; - -@end - -/** - - */ -@interface AWSEC2CancelSpotInstanceRequestsResult : AWSModel - - -/** -One or more Spot Instance requests.
- */ -@property (nonatomic, strong) NSArray *cancelledSpotInstanceRequests; - -@end - -/** -Describes a request to cancel a Spot Instance.
- */ -@interface AWSEC2CancelledSpotInstanceRequest : AWSModel - - -/** -The ID of the Spot Instance request.
- */ -@property (nonatomic, strong) NSString *spotInstanceRequestId; - -/** -The state of the Spot Instance request.
- */ -@property (nonatomic, assign) AWSEC2CancelSpotInstanceRequestState state; - -@end - -/** - - */ -@interface AWSEC2ConfirmProductInstanceRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The product code. This must be a product code that you own.
- */ -@property (nonatomic, strong) NSString *productCode; - -@end - -/** - - */ -@interface AWSEC2ConfirmProductInstanceResult : AWSModel - - -/** -The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.
- */ -@property (nonatomic, strong) NSString *ownerId; - -@end - -/** -Describes a conversion task.
- Required parameters: [ConversionTaskId, State] - */ -@interface AWSEC2ConversionTask : AWSModel - - -/** -The ID of the conversion task.
- */ -@property (nonatomic, strong) NSString *conversionTaskId; - -/** -The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
- */ -@property (nonatomic, strong) NSString *expirationTime; - -/** -If the task is for importing an instance, this contains information about the import instance task.
- */ -@property (nonatomic, strong) AWSEC2ImportInstanceTaskDetails *importInstance; - -/** -If the task is for importing a volume, this contains information about the import volume task.
- */ -@property (nonatomic, strong) AWSEC2ImportVolumeTaskDetails *importVolume; - -/** -The state of the conversion task.
- */ -@property (nonatomic, assign) AWSEC2ConversionTaskState state; - -/** -The status message related to the conversion task.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -/** - - */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** - - */ -@interface AWSEC2CreateCustomerGatewayRequest : AWSRequest - - -/** -For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
- */ -@property (nonatomic, strong) NSNumber *bgpAsn; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
- */ -@property (nonatomic, strong) NSString *publicIp; - -/** -The type of VPN connection that this customer gateway supports (ipsec.1).
Information about the customer gateway.
- */ -@property (nonatomic, strong) AWSEC2CustomerGateway *customerGateway; - -@end - -/** - - */ -@interface AWSEC2CreateDhcpOptionsRequest : AWSRequest - - -/** -A DHCP configuration option.
- */ -@property (nonatomic, strong) NSArray *dhcpConfigurations; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2CreateDhcpOptionsResult : AWSModel - - -/** -A set of DHCP options.
- */ -@property (nonatomic, strong) AWSEC2DhcpOptions *dhcpOptions; - -@end - -/** - - */ -@interface AWSEC2CreateImageRequest : AWSRequest - - -/** -Information about one or more block device mappings.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -A description for the new image.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
- */ -@property (nonatomic, strong) NSString *name; - -/** -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.
The ID of the new AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -@end - -/** - - */ -@interface AWSEC2CreateInstanceExportTaskRequest : AWSRequest - - -/** -A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) AWSEC2ExportToS3TaskSpecification *exportToS3Task; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The target virtualization environment.
- */ -@property (nonatomic, assign) AWSEC2ExportEnvironment targetEnvironment; - -@end - -/** - - */ -@interface AWSEC2CreateInstanceExportTaskResult : AWSModel - - -/** -Describes an export task.
- */ -@property (nonatomic, strong) AWSEC2ExportTask *exportTask; - -@end - -/** - - */ -@interface AWSEC2CreateInternetGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2CreateInternetGatewayResult : AWSModel - - -/** -Information about the Internet gateway.
- */ -@property (nonatomic, strong) AWSEC2InternetGateway *internetGateway; - -@end - -/** - - */ -@interface AWSEC2CreateKeyPairRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -A unique name for the key pair.
Constraints: Up to 255 ASCII characters
- */ -@property (nonatomic, strong) NSString *keyName; - -@end - -/** - - */ -@interface AWSEC2CreateNetworkAclEntryRequest : AWSRequest - - -/** -The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
- */ -@property (nonatomic, strong) NSNumber *egress; - -/** -ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.
- */ -@property (nonatomic, strong) AWSEC2IcmpTypeCode *icmpTypeCode; - -/** -The ID of the network ACL.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -/** -TCP or UDP protocols: The range of ports the rule applies to.
- */ -@property (nonatomic, strong) AWSEC2PortRange *portRange; - -/** -The protocol. A value of -1 means all protocols.
- */ -@property (nonatomic, strong) NSString *protocols; - -/** -Indicates whether to allow or deny the traffic that matches the rule.
- */ -@property (nonatomic, assign) AWSEC2RuleAction ruleAction; - -/** -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
- */ -@property (nonatomic, strong) NSNumber *ruleNumber; - -@end - -/** - - */ -@interface AWSEC2CreateNetworkAclRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2CreateNetworkAclResult : AWSModel - - -/** -Information about the network ACL.
- */ -@property (nonatomic, strong) AWSEC2NetworkAcl *networkAcl; - -@end - -/** - - */ -@interface AWSEC2CreateNetworkInterfaceRequest : AWSRequest - - -/** -A description for the network interface.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The IDs of one or more security groups.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -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).
One or more private IP addresses.
- */ -@property (nonatomic, strong) NSArray *privateIpAddresses; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *secondaryPrivateIpAddressCount; - -/** -The ID of the subnet to associate with the network interface.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** - - */ -@interface AWSEC2CreateNetworkInterfaceResult : AWSModel - - -/** -Information about the network interface.
- */ -@property (nonatomic, strong) AWSEC2NetworkInterface *networkInterface; - -@end - -/** - - */ -@interface AWSEC2CreatePlacementGroupRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -A name for the placement group.
Constraints: Up to 255 ASCII characters
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -The placement strategy.
- */ -@property (nonatomic, assign) AWSEC2PlacementStrategy strategy; - -@end - -/** - - */ -@interface AWSEC2CreateReservedInstancesListingRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *instanceCount; - -/** -A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.
- */ -@property (nonatomic, strong) NSArray *priceSchedules; - -/** -The ID of the active Reserved Instance.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -@end - -/** - - */ -@interface AWSEC2CreateReservedInstancesListingResult : AWSModel - - -/** -Information about the Reserved Instances listing.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesListings; - -@end - -/** - - */ -@interface AWSEC2CreateRouteRequest : AWSRequest - - -/** -The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of an Internet gateway or virtual private gateway attached to your VPC.
- */ -@property (nonatomic, strong) NSString *gatewayId; - -/** -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.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The ID of a network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The ID of the route table for the route.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -/** -The ID of a VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** - - */ -@interface AWSEC2CreateRouteTableRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2CreateRouteTableResult : AWSModel - - -/** -Information about the route table.
- */ -@property (nonatomic, strong) AWSEC2RouteTable *routeTable; - -@end - -/** - - */ -@interface AWSEC2CreateSecurityGroupRequest : AWSRequest - - -/** -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 ._-:/()#,@[]+=&;{}!$*
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 ._-:/()#,@[]+=&;{}!$*
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2CreateSecurityGroupResult : AWSModel - - -/** -The ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -@end - -/** - - */ -@interface AWSEC2CreateSnapshotRequest : AWSRequest - - -/** -A description for the snapshot.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Amazon EBS volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2CreateSpotDatafeedSubscriptionRequest : AWSRequest - - -/** -The Amazon S3 bucket in which to store the Spot Instance datafeed.
Constraints: Must be a valid bucket associated with your AWS account.
- */ -@property (nonatomic, strong) NSString *bucket; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -A prefix for the datafeed file names.
- */ -@property (nonatomic, strong) NSString *prefix; - -@end - -/** - - */ -@interface AWSEC2CreateSpotDatafeedSubscriptionResult : AWSModel - - -/** -The Spot Instance datafeed subscription.
- */ -@property (nonatomic, strong) AWSEC2SpotDatafeedSubscription *spotDatafeedSubscription; - -@end - -/** - - */ -@interface AWSEC2CreateSubnetRequest : AWSRequest - - -/** -The Availability Zone for the subnet.
Default: Amazon EC2 selects one for you (recommended).
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2CreateSubnetResult : AWSModel - - -/** -Information about the subnet.
- */ -@property (nonatomic, strong) AWSEC2Subnet *subnet; - -@end - -/** - - */ -@interface AWSEC2CreateTagsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
- */ -@property (nonatomic, strong) NSArray *resources; - -/** -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 group that is to be added or removed from a volume's list of create volume permissions.
- */ -@property (nonatomic, assign) AWSEC2PermissionGroup group; - -/** -The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.
- */ -@property (nonatomic, strong) NSString *userId; - -@end - -/** - - */ -@interface AWSEC2CreateVolumePermissionModifications : AWSModel - - -/** -Adds a specific AWS account ID or group to a volume's list of create volume permissions.
- */ -@property (nonatomic, strong) NSArray *add; - -/** -Removes a specific AWS account ID or group from a volume's list of create volume permissions.
- */ -@property (nonatomic, strong) NSArray *remove; - -@end - -/** - - */ -@interface AWSEC2CreateVolumeRequest : AWSRequest - - -/** -The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -Specifies whether the volume should be encrypted.
- */ -@property (nonatomic, strong) NSNumber *encrypted; - -/** -Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume.
- */ -@property (nonatomic, strong) NSNumber *iops; - -/** -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 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.
- */ -@property (nonatomic, strong) NSNumber *size; - -/** -The snapshot from which to create the volume.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -/** -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
The AWS account ID of the owner of the peer VPC.
Default: Your AWS account ID
- */ -@property (nonatomic, strong) NSString *peerOwnerId; - -/** -The ID of the VPC with which you are creating the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *peerVpcId; - -/** -The ID of the requester VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2CreateVpcPeeringConnectionResult : AWSModel - - -/** -Information about the VPC peering connection.
- */ -@property (nonatomic, strong) AWSEC2VpcPeeringConnection *vpcPeeringConnection; - -@end - -/** - - */ -@interface AWSEC2CreateVpcRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2Vpc *vpc; - -@end - -/** - - */ -@interface AWSEC2CreateVpnConnectionRequest : AWSRequest - - -/** -The ID of the customer gateway.
- */ -@property (nonatomic, strong) NSString *customerGatewayId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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
The type of VPN connection (ipsec.1).
The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *vpnGatewayId; - -@end - -/** - - */ -@interface AWSEC2CreateVpnConnectionResult : AWSModel - - -/** -Information about the VPN connection.
- */ -@property (nonatomic, strong) AWSEC2VpnConnection *vpnConnection; - -@end - -/** - - */ -@interface AWSEC2CreateVpnConnectionRouteRequest : AWSRequest - - -/** -The CIDR block associated with the local subnet of the customer network.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** -The ID of the VPN connection.
- */ -@property (nonatomic, strong) NSString *vpnConnectionId; - -@end - -/** - - */ -@interface AWSEC2CreateVpnGatewayRequest : AWSRequest - - -/** -The Availability Zone for the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The type of VPN connection this virtual private gateway supports.
- */ -@property (nonatomic, assign) AWSEC2GatewayType types; - -@end - -/** - - */ -@interface AWSEC2CreateVpnGatewayResult : AWSModel - - -/** -Information about the virtual private gateway.
- */ -@property (nonatomic, strong) AWSEC2VpnGateway *vpnGateway; - -@end - -/** -Describes a customer gateway.
- */ -@interface AWSEC2CustomerGateway : AWSModel - - -/** -The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
- */ -@property (nonatomic, strong) NSString *bgpAsn; - -/** -The ID of the customer gateway.
- */ -@property (nonatomic, strong) NSString *customerGatewayId; - -/** -The Internet-routable IP address of the customer gateway's outside interface.
- */ -@property (nonatomic, strong) NSString *ipAddress; - -/** -The current state of the customer gateway (pending | available | deleting | deleted).
Any tags assigned to the customer gateway.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The type of VPN connection the customer gateway supports (ipsec.1).
The ID of the customer gateway.
- */ -@property (nonatomic, strong) NSString *customerGatewayId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2DeleteDhcpOptionsRequest : AWSRequest - - -/** -The ID of the DHCP options set.
- */ -@property (nonatomic, strong) NSString *dhcpOptionsId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2DeleteInternetGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Internet gateway.
- */ -@property (nonatomic, strong) NSString *internetGatewayId; - -@end - -/** - - */ -@interface AWSEC2DeleteKeyPairRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The name of the key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -@end - -/** - - */ -@interface AWSEC2DeleteNetworkAclEntryRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -Indicates whether the rule is an egress rule.
- */ -@property (nonatomic, strong) NSNumber *egress; - -/** -The ID of the network ACL.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -/** -The rule number of the entry to delete.
- */ -@property (nonatomic, strong) NSNumber *ruleNumber; - -@end - -/** - - */ -@interface AWSEC2DeleteNetworkAclRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the network ACL.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -@end - -/** - - */ -@interface AWSEC2DeleteNetworkInterfaceRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -@end - -/** - - */ -@interface AWSEC2DeletePlacementGroupRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The name of the placement group.
- */ -@property (nonatomic, strong) NSString *groupName; - -@end - -/** - - */ -@interface AWSEC2DeleteRouteRequest : AWSRequest - - -/** -The CIDR range for the route. The value you specify must match the CIDR for the route exactly.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -@end - -/** - - */ -@interface AWSEC2DeleteRouteTableRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -@end - -/** - - */ -@interface AWSEC2DeleteSecurityGroupRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the security group. Required for a nondefault VPC.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
- */ -@property (nonatomic, strong) NSString *groupName; - -@end - -/** - - */ -@interface AWSEC2DeleteSnapshotRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Amazon EBS snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -@end - -/** - - */ -@interface AWSEC2DeleteSpotDatafeedSubscriptionRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2DeleteSubnetRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** - - */ -@interface AWSEC2DeleteTagsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
- */ -@property (nonatomic, strong) NSArray *resources; - -/** -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.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2DeleteVpcPeeringConnectionRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** - - */ -@interface AWSEC2DeleteVpcPeeringConnectionResult : AWSModel - - -/** -Returns true if the request succeeds; otherwise, it returns an error.
The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2DeleteVpnConnectionRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPN connection.
- */ -@property (nonatomic, strong) NSString *vpnConnectionId; - -@end - -/** - - */ -@interface AWSEC2DeleteVpnConnectionRouteRequest : AWSRequest - - -/** -The CIDR block associated with the local subnet of the customer network.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** -The ID of the VPN connection.
- */ -@property (nonatomic, strong) NSString *vpnConnectionId; - -@end - -/** - - */ -@interface AWSEC2DeleteVpnGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *vpnGatewayId; - -@end - -/** - - */ -@interface AWSEC2DeregisterImageRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -@end - -/** - - */ -@interface AWSEC2DescribeAccountAttributesRequest : AWSRequest - - -/** -One or more account attribute names.
- */ -@property (nonatomic, strong) NSArray *attributeNames; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2DescribeAccountAttributesResult : AWSModel - - -/** -Information about one or more account attributes.
- */ -@property (nonatomic, strong) NSArray *accountAttributes; - -@end - -/** - - */ -@interface AWSEC2DescribeAddressesRequest : AWSRequest - - -/** -[EC2-VPC] One or more allocation IDs.
Default: Describes all your Elastic IP addresses.
- */ -@property (nonatomic, strong) NSArray *allocationIds; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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-Classic] One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
- */ -@property (nonatomic, strong) NSArray *publicIps; - -@end - -/** - - */ -@interface AWSEC2DescribeAddressesResult : AWSModel - - -/** -Information about one or more Elastic IP addresses.
- */ -@property (nonatomic, strong) NSArray *addresses; - -@end - -/** - - */ -@interface AWSEC2DescribeAvailabilityZonesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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).
The names of one or more Availability Zones.
- */ -@property (nonatomic, strong) NSArray *zoneNames; - -@end - -/** - - */ -@interface AWSEC2DescribeAvailabilityZonesResult : AWSModel - - -/** -Information about one or more Availability Zones.
- */ -@property (nonatomic, strong) NSArray *availabilityZones; - -@end - -/** - - */ -@interface AWSEC2DescribeBundleTasksRequest : AWSRequest - - -/** -One or more bundle task IDs.
Default: Describes all your bundle tasks.
- */ -@property (nonatomic, strong) NSArray *bundleIds; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *bundleTasks; - -@end - -/** - - */ -@interface AWSEC2DescribeConversionTasksRequest : AWSRequest - - -/** -One or more conversion task IDs.
- */ -@property (nonatomic, strong) NSArray *conversionTaskIds; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** - - */ -@property (nonatomic, strong) NSArray *filters; - -@end - -/** - - */ -@interface AWSEC2DescribeConversionTasksResult : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSArray *conversionTasks; - -@end - -/** - - */ -@interface AWSEC2DescribeCustomerGatewaysRequest : AWSRequest - - -/** -One or more customer gateway IDs.
Default: Describes all your customer gateways.
- */ -@property (nonatomic, strong) NSArray *customerGatewayIds; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *customerGateways; - -@end - -/** - - */ -@interface AWSEC2DescribeDhcpOptionsRequest : AWSRequest - - -/** -The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
- */ -@property (nonatomic, strong) NSArray *dhcpOptionsIds; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *dhcpOptions; - -@end - -/** - - */ -@interface AWSEC2DescribeExportTasksRequest : AWSRequest - - -/** -One or more export task IDs.
- */ -@property (nonatomic, strong) NSArray *exportTaskIds; - -@end - -/** - - */ -@interface AWSEC2DescribeExportTasksResult : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSArray *exportTasks; - -@end - -/** - - */ -@interface AWSEC2DescribeImageAttributeRequest : AWSRequest - - -/** -The AMI attribute.
- */ -@property (nonatomic, assign) AWSEC2ImageAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -@end - -/** - - */ -@interface AWSEC2DescribeImagesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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).
One or more image IDs.
Default: Describes all images available to you.
- */ -@property (nonatomic, strong) NSArray *imageIds; - -/** -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).
Information about one or more images.
- */ -@property (nonatomic, strong) NSArray *images; - -@end - -/** - - */ -@interface AWSEC2DescribeInstanceAttributeRequest : AWSRequest - - -/** -The instance attribute.
- */ -@property (nonatomic, assign) AWSEC2InstanceAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -@end - -/** - - */ -@interface AWSEC2DescribeInstanceStatusRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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).
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 IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -/** -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
- */ -@property (nonatomic, strong) NSNumber *maxResults; - -/** -The next paginated set of results to return. (You received this token from a prior call.)
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSEC2DescribeInstanceStatusResult : AWSModel - - -/** -One or more instance status descriptions.
- */ -@property (nonatomic, strong) NSArray *instanceStatuses; - -/** -The next paginated set of results to return.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSEC2DescribeInstancesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more instance IDs.
Default: Describes all your instances.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *maxResults; - -/** -The token for the next set of items to return. (You received this token from a prior call.)
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSEC2DescribeInstancesResult : AWSModel - - -/** -The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -One or more reservations.
- */ -@property (nonatomic, strong) NSArray *reservations; - -@end - -/** - - */ -@interface AWSEC2DescribeInternetGatewaysRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more Internet gateway IDs.
Default: Describes all your Internet gateways.
- */ -@property (nonatomic, strong) NSArray *internetGatewayIds; - -@end - -/** - - */ -@interface AWSEC2DescribeInternetGatewaysResult : AWSModel - - -/** -Information about one or more Internet gateways.
- */ -@property (nonatomic, strong) NSArray *internetGateways; - -@end - -/** - - */ -@interface AWSEC2DescribeKeyPairsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more filters.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
One or more key pair names.
Default: Describes all your key pairs.
- */ -@property (nonatomic, strong) NSArray *keyNames; - -@end - -/** - - */ -@interface AWSEC2DescribeKeyPairsResult : AWSModel - - -/** -Information about one or more key pairs.
- */ -@property (nonatomic, strong) NSArray *keyPairs; - -@end - -/** - - */ -@interface AWSEC2DescribeNetworkAclsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more network ACL IDs.
Default: Describes all your network ACLs.
- */ -@property (nonatomic, strong) NSArray *networkAclIds; - -@end - -/** - - */ -@interface AWSEC2DescribeNetworkAclsResult : AWSModel - - -/** -Information about one or more network ACLs.
- */ -@property (nonatomic, strong) NSArray *networkAcls; - -@end - -/** - - */ -@interface AWSEC2DescribeNetworkInterfaceAttributeRequest : AWSRequest - - -/** -The attribute of the network interface.
- */ -@property (nonatomic, assign) AWSEC2NetworkInterfaceAttribute attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -@end - -/** - - */ -@interface AWSEC2DescribeNetworkInterfaceAttributeResult : AWSModel - - -/** -The attachment (if any) of the network interface.
- */ -@property (nonatomic, strong) AWSEC2NetworkInterfaceAttachment *attachment; - -/** -The description of the network interface.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *detail; - -/** -The security groups associated with the network interface.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -Indicates whether source/destination checking is enabled.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *sourceDestCheck; - -@end - -/** - - */ -@interface AWSEC2DescribeNetworkInterfacesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more network interface IDs.
Default: Describes all your network interfaces.
- */ -@property (nonatomic, strong) NSArray *networkInterfaceIds; - -@end - -/** - - */ -@interface AWSEC2DescribeNetworkInterfacesResult : AWSModel - - -/** -Information about one or more network interfaces.
- */ -@property (nonatomic, strong) NSArray *networkInterfaces; - -@end - -/** - - */ -@interface AWSEC2DescribePlacementGroupsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 group names.
Default: Describes all your placement groups, or only those otherwise specified.
- */ -@property (nonatomic, strong) NSArray *groupNames; - -@end - -/** - - */ -@interface AWSEC2DescribePlacementGroupsResult : AWSModel - - -/** -One or more placement groups.
- */ -@property (nonatomic, strong) NSArray *placementGroups; - -@end - -/** - - */ -@interface AWSEC2DescribeRegionsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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).
The names of one or more regions.
- */ -@property (nonatomic, strong) NSArray *regionNames; - -@end - -/** - - */ -@interface AWSEC2DescribeRegionsResult : AWSModel - - -/** -Information about one or more regions.
- */ -@property (nonatomic, strong) NSArray *regions; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesListingsRequest : AWSRequest - - -/** -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.
One or more Reserved Instance IDs.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -/** -One or more Reserved Instance Listing IDs.
- */ -@property (nonatomic, strong) NSString *reservedInstancesListingId; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesListingsResult : AWSModel - - -/** -Information about the Reserved Instance listing.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesListings; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesModificationsRequest : AWSRequest - - -/** -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 token for the next page of data.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -IDs for the submitted modification request.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesModificationIds; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesModificationsResult : AWSModel - - -/** -The token for the next page of data.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -The Reserved Instance modification information.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesModifications; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesOfferingsRequest : AWSRequest - - -/** -The Availability Zone in which the Reserved Instance can be used.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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).
Include Marketplace offerings in the response.
- */ -@property (nonatomic, strong) NSNumber *includeMarketplace; - -/** -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 instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** -The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
- */ -@property (nonatomic, strong) NSNumber *maxDuration; - -/** -The maximum number of instances to filter when searching for offerings.
Default: 20
- */ -@property (nonatomic, strong) NSNumber *maxInstanceCount; - -/** -The maximum number of offerings to return. The maximum is 100.
Default: 100
- */ -@property (nonatomic, strong) NSNumber *maxResults; - -/** -The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
- */ -@property (nonatomic, strong) NSNumber *minDuration; - -/** -The token to use when requesting the next paginated set of offerings.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -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 Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
One or more Reserved Instances offering IDs.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesOfferingIds; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesOfferingsResult : AWSModel - - -/** -The next paginated set of results to return.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of Reserved Instances offerings.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesOfferings; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesIds; - -@end - -/** - - */ -@interface AWSEC2DescribeReservedInstancesResult : AWSModel - - -/** -A list of Reserved Instances.
- */ -@property (nonatomic, strong) NSArray *reservedInstances; - -@end - -/** - - */ -@interface AWSEC2DescribeRouteTablesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more route table IDs.
Default: Describes all your route tables.
- */ -@property (nonatomic, strong) NSArray *routeTableIds; - -@end - -/** - - */ -@interface AWSEC2DescribeRouteTablesResult : AWSModel - - -/** -Information about one or more route tables.
- */ -@property (nonatomic, strong) NSArray *routeTables; - -@end - -/** - - */ -@interface AWSEC2DescribeSecurityGroupsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more security group IDs. Required for nondefault VPCs.
Default: Describes all your security groups.
- */ -@property (nonatomic, strong) NSArray *groupIds; - -/** -[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.
- */ -@property (nonatomic, strong) NSArray *groupNames; - -@end - -/** - - */ -@interface AWSEC2DescribeSecurityGroupsResult : AWSModel - - -/** -Information about one or more security groups.
- */ -@property (nonatomic, strong) NSArray *securityGroups; - -@end - -/** - - */ -@interface AWSEC2DescribeSnapshotAttributeRequest : AWSRequest - - -/** -The snapshot attribute you would like to view.
- */ -@property (nonatomic, assign) AWSEC2SnapshotAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Amazon EBS snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -@end - -/** - - */ -@interface AWSEC2DescribeSnapshotAttributeResult : AWSModel - - -/** -A list of permissions for creating volumes from the snapshot.
- */ -@property (nonatomic, strong) NSArray *createVolumePermissions; - -/** -A list of product codes.
- */ -@property (nonatomic, strong) NSArray *productCodes; - -/** -The ID of the Amazon EBS snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -@end - -/** - - */ -@interface AWSEC2DescribeSnapshotsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
- */ -@property (nonatomic, strong) NSArray *ownerIds; - -/** -One or more AWS accounts IDs that can create volumes from the snapshot.
- */ -@property (nonatomic, strong) NSArray *restorableByUserIds; - -/** -One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
- */ -@property (nonatomic, strong) NSArray *snapshotIds; - -@end - -/** - - */ -@interface AWSEC2DescribeSnapshotsResult : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSArray *snapshots; - -@end - -/** - - */ -@interface AWSEC2DescribeSpotDatafeedSubscriptionRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** - - */ -@interface AWSEC2DescribeSpotDatafeedSubscriptionResult : AWSModel - - -/** -The Spot Instance datafeed subscription.
- */ -@property (nonatomic, strong) AWSEC2SpotDatafeedSubscription *spotDatafeedSubscription; - -@end - -/** - - */ -@interface AWSEC2DescribeSpotInstanceRequestsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 request IDs.
- */ -@property (nonatomic, strong) NSArray *spotInstanceRequestIds; - -@end - -/** - - */ -@interface AWSEC2DescribeSpotInstanceRequestsResult : AWSModel - - -/** -One or more Spot Instance requests.
- */ -@property (nonatomic, strong) NSArray *spotInstanceRequests; - -@end - -/** - - */ -@interface AWSEC2DescribeSpotPriceHistoryRequest : AWSRequest - - -/** -The Availability Zone.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The end date and time of the Spot Price history data.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -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.
One or more instance types.
- */ -@property (nonatomic, strong) NSArray *instanceTypes; - -/** -The number of rows to return.
- */ -@property (nonatomic, strong) NSNumber *maxResults; - -/** -The next set of rows to return.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -One or more basic product descriptions.
- */ -@property (nonatomic, strong) NSArray *productDescriptions; - -/** -The start date and time of the Spot Price history data.
- */ -@property (nonatomic, strong) NSDate *startTime; - -@end - -/** - - */ -@interface AWSEC2DescribeSpotPriceHistoryResult : AWSModel - - -/** -The string marking the next set of results. This is empty if there are no more results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -The historical Spot Prices.
- */ -@property (nonatomic, strong) NSArray *spotPriceHistory; - -@end - -/** - - */ -@interface AWSEC2DescribeSubnetsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more subnet IDs.
Default: Describes all your subnets.
- */ -@property (nonatomic, strong) NSArray *subnetIds; - -@end - -/** - - */ -@interface AWSEC2DescribeSubnetsResult : AWSModel - - -/** -Information about one or more subnets.
- */ -@property (nonatomic, strong) NSArray *subnets; - -@end - -/** - - */ -@interface AWSEC2DescribeTagsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *maxResults; - -/** -The token for the next set of items to return. (You received this token from a prior call.)
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** - - */ -@interface AWSEC2DescribeTagsResult : AWSModel - - -/** -The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of tags.
- */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** - - */ -@interface AWSEC2DescribeVolumeAttributeRequest : AWSRequest - - -/** -The instance attribute.
- */ -@property (nonatomic, assign) AWSEC2VolumeAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2DescribeVolumeAttributeResult : AWSModel - - -/** -The state of autoEnableIO attribute.
A list of product codes.
- */ -@property (nonatomic, strong) NSArray *productCodes; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2DescribeVolumeStatusRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 maximum number of paginated volume items per response.
- */ -@property (nonatomic, strong) NSNumber *maxResults; - -/** -The next paginated set of results to return using the pagination token returned by a previous call.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -One or more volume IDs.
Default: Describes all your volumes.
- */ -@property (nonatomic, strong) NSArray *volumeIds; - -@end - -/** - - */ -@interface AWSEC2DescribeVolumeStatusResult : AWSModel - - -/** -The next paginated set of results to return.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -A list of volumes.
- */ -@property (nonatomic, strong) NSArray *volumeStatuses; - -@end - -/** - - */ -@interface AWSEC2DescribeVolumesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 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 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.
One or more volume IDs.
- */ -@property (nonatomic, strong) NSArray *volumeIds; - -@end - -/** - - */ -@interface AWSEC2DescribeVolumesResult : AWSModel - - -/** -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 VPC attribute.
- */ -@property (nonatomic, assign) AWSEC2VpcAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2DescribeVpcAttributeResult : AWSModel - - -/** -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.
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.
The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2DescribeVpcPeeringConnectionsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
- */ -@property (nonatomic, strong) NSArray *vpcPeeringConnectionIds; - -@end - -/** - - */ -@interface AWSEC2DescribeVpcPeeringConnectionsResult : AWSModel - - -/** -Information about the VPC peering connections.
- */ -@property (nonatomic, strong) NSArray *vpcPeeringConnections; - -@end - -/** - - */ -@interface AWSEC2DescribeVpcsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more VPC IDs.
Default: Describes all your VPCs.
- */ -@property (nonatomic, strong) NSArray *vpcIds; - -@end - -/** - - */ -@interface AWSEC2DescribeVpcsResult : AWSModel - - -/** -Information about one or more VPCs.
- */ -@property (nonatomic, strong) NSArray *vpcs; - -@end - -/** - - */ -@interface AWSEC2DescribeVpnConnectionsRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more VPN connection IDs.
Default: Describes your VPN connections.
- */ -@property (nonatomic, strong) NSArray *vpnConnectionIds; - -@end - -/** - - */ -@interface AWSEC2DescribeVpnConnectionsResult : AWSModel - - -/** -Information about one or more VPN connections.
- */ -@property (nonatomic, strong) NSArray *vpnConnections; - -@end - -/** - - */ -@interface AWSEC2DescribeVpnGatewaysRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
- */ -@property (nonatomic, strong) NSArray *vpnGatewayIds; - -@end - -/** - - */ -@interface AWSEC2DescribeVpnGatewaysResult : AWSModel - - -/** -Information about one or more virtual private gateways.
- */ -@property (nonatomic, strong) NSArray *vpnGateways; - -@end - -/** - - */ -@interface AWSEC2DetachInternetGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Internet gateway.
- */ -@property (nonatomic, strong) NSString *internetGatewayId; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2DetachNetworkInterfaceRequest : AWSRequest - - -/** -The ID of the attachment.
- */ -@property (nonatomic, strong) NSString *attachmentId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -Specifies whether to force a detachment.
- */ -@property (nonatomic, strong) NSNumber *force; - -@end - -/** - - */ -@interface AWSEC2DetachVolumeRequest : AWSRequest - - -/** -The device name.
- */ -@property (nonatomic, strong) NSString *device; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *force; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2DetachVpnGatewayRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -/** -The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *vpnGatewayId; - -@end - -/** -Describes a DHCP configuration option.
- */ -@interface AWSEC2DhcpConfiguration : AWSModel - - -/** -The name of a DHCP option.
- */ -@property (nonatomic, strong) NSString *key; - -/** -One or more values for the DHCP option.
- */ -@property (nonatomic, strong) NSArray *values; - -@end - -/** -Describes a set of DHCP options.
- */ -@interface AWSEC2DhcpOptions : AWSModel - - -/** -One or more DHCP options in the set.
- */ -@property (nonatomic, strong) NSArray *dhcpConfigurations; - -/** -The ID of the set of DHCP options.
- */ -@property (nonatomic, strong) NSString *dhcpOptionsId; - -/** -Any tags assigned to the DHCP options set.
- */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** - - */ -@interface AWSEC2DisableVgwRoutePropagationRequest : AWSRequest - - -/** -The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *gatewayId; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -@end - -/** - - */ -@interface AWSEC2DisassociateAddressRequest : AWSRequest - - -/** -[EC2-VPC] The association ID. Required for EC2-VPC.
- */ -@property (nonatomic, strong) NSString *associationId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** - - */ -@interface AWSEC2DisassociateRouteTableRequest : AWSRequest - - -/** -The association ID representing the current association between the route table and subnet.
- */ -@property (nonatomic, strong) NSString *associationId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -@end - -/** -Describes a disk image.
- */ -@interface AWSEC2DiskImage : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) AWSEC2DiskImageDetail *image; - -/** -Describes an Amazon EBS volume.
- */ -@property (nonatomic, strong) AWSEC2VolumeDetail *volume; - -@end - -/** - - */ -@interface AWSEC2DiskImageDescription : AWSModel - - -/** -The checksum computed for the disk image.
- */ -@property (nonatomic, strong) NSString *checksum; - -/** -The disk image format.
- */ -@property (nonatomic, assign) AWSEC2DiskImageFormat format; - -/** -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.
- */ -@property (nonatomic, strong) NSString *importManifestUrl; - -/** -The size of the disk image.
- */ -@property (nonatomic, strong) NSNumber *size; - -@end - -/** - - */ -@interface AWSEC2DiskImageDetail : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSNumber *bytes; - -/** -The disk image format.
- */ -@property (nonatomic, assign) AWSEC2DiskImageFormat format; - -/** -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.
- */ -@property (nonatomic, strong) NSString *importManifestUrl; - -@end - -/** - - */ -@interface AWSEC2DiskImageVolumeDescription : AWSModel - - -/** -The volume identifier.
- */ -@property (nonatomic, strong) NSString *identifier; - -/** -The size of the volume.
- */ -@property (nonatomic, strong) NSNumber *size; - -@end - -/** -Describes an Amazon EBS block device.
- */ -@interface AWSEC2EbsBlockDevice : AWSModel - - -/** -Indicates whether the Amazon EBS volume is deleted on instance termination.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -/** -Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
- */ -@property (nonatomic, strong) NSNumber *encrypted; - -/** -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.
The ID of the snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *volumeSize; - -/** -The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.
Default: standard
Describes a parameter used to set up an Amazon EBS volume in a block device mapping.
- */ -@interface AWSEC2EbsInstanceBlockDevice : AWSModel - - -/** -The time stamp when the attachment initiated.
- */ -@property (nonatomic, strong) NSDate *attachTime; - -/** -Indicates whether the volume is deleted on instance termination.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -/** -The attachment state.
- */ -@property (nonatomic, assign) AWSEC2AttachmentStatus status; - -/** -The ID of the Amazon EBS volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2EbsInstanceBlockDeviceSpecification : AWSModel - - -/** -Indicates whether the volume is deleted on instance termination.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -/** -The ID of the Amazon EBS volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2EnableVgwRoutePropagationRequest : AWSRequest - - -/** -The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *gatewayId; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -@end - -/** - - */ -@interface AWSEC2EnableVolumeIORequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** -Describes an export task.
- */ -@interface AWSEC2ExportTask : AWSModel - - -/** -A description of the resource being exported.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The ID of the export task.
- */ -@property (nonatomic, strong) NSString *exportTaskId; - -/** - - */ -@property (nonatomic, strong) AWSEC2ExportToS3Task *exportToS3Task; - -/** -The instance being exported.
- */ -@property (nonatomic, strong) AWSEC2InstanceExportDetails *instanceExportDetails; - -/** -The state of the conversion task.
- */ -@property (nonatomic, assign) AWSEC2ExportTaskState state; - -/** -The status message related to the export task.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -@end - -/** - - */ -@interface AWSEC2ExportToS3Task : AWSModel - - -/** -The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
- */ -@property (nonatomic, assign) AWSEC2ContainerFormat containerFormat; - -/** -The format for the exported image.
- */ -@property (nonatomic, assign) AWSEC2DiskImageFormat diskImageFormat; - -/** -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.
- */ -@property (nonatomic, strong) NSString *s3Prefix; - -@end - -/** -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.
- */ -@interface AWSEC2Filter : AWSModel - - -/** -The name of the filter. Filter names are case-sensitive.
- */ -@property (nonatomic, strong) NSString *name; - -/** -One or more filter values. Filter values are case-sensitive.
- */ -@property (nonatomic, strong) NSArray *values; - -@end - -/** - - */ -@interface AWSEC2GetConsoleOutputRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -@end - -/** - - */ -@interface AWSEC2GetConsoleOutputResult : AWSModel - - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The console output, Base64 encoded.
- */ -@property (nonatomic, strong) NSString *output; - -/** -The time the output was last updated.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -@end - -/** - - */ -@interface AWSEC2GetPasswordDataRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the Windows instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -@end - -/** - - */ -@interface AWSEC2GetPasswordDataResult : AWSModel - - -/** -The ID of the Windows instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The password of the instance.
- */ -@property (nonatomic, strong) NSString *passwordData; - -/** -The time the data was last updated.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -@end - -/** -Describes a security group.
- */ -@interface AWSEC2GroupIdentifier : AWSModel - - -/** -The ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -The name of the security group.
- */ -@property (nonatomic, strong) NSString *groupName; - -@end - -/** -Describes an IAM instance profile.
- */ -@interface AWSEC2IamInstanceProfile : AWSModel - - -/** -The Amazon Resource Name (ARN) of the instance profile.
- */ -@property (nonatomic, strong) NSString *arn; - -/** -The ID of the instance profile.
- */ -@property (nonatomic, strong) NSString *identifier; - -@end - -/** -Describes an IAM instance profile.
- */ -@interface AWSEC2IamInstanceProfileSpecification : AWSModel - - -/** -The Amazon Resource Name (ARN) of the instance profile.
- */ -@property (nonatomic, strong) NSString *arn; - -/** -The name of the instance profile.
- */ -@property (nonatomic, strong) NSString *name; - -@end - -/** -Describes the ICMP type and code.
- */ -@interface AWSEC2IcmpTypeCode : AWSModel - - -/** -The ICMP type. A value of -1 means all types.
- */ -@property (nonatomic, strong) NSNumber *code; - -/** -The ICMP code. A value of -1 means all codes for the specified ICMP type.
- */ -@property (nonatomic, strong) NSNumber *types; - -@end - -/** -Describes an image.
- */ -@interface AWSEC2Image : AWSModel - - -/** -The architecture of the image.
- */ -@property (nonatomic, assign) AWSEC2ArchitectureValues architecture; - -/** -Any block device mapping entries.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -The description of the AMI that was provided during image creation.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The hypervisor type of the image.
- */ -@property (nonatomic, assign) AWSEC2HypervisorType hypervisor; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -The location of the AMI.
- */ -@property (nonatomic, strong) NSString *imageLocation; - -/** -The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
The type of image.
- */ -@property (nonatomic, assign) AWSEC2ImageTypeValues imageType; - -/** -The kernel associated with the image, if any. Only applicable for machine images.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -The name of the AMI that was provided during image creation.
- */ -@property (nonatomic, strong) NSString *name; - -/** -The AWS account ID of the image owner.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The value is Windows for Windows AMIs; otherwise blank.
Any product codes associated with the AMI.
- */ -@property (nonatomic, strong) NSArray *productCodes; - -/** -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.
The RAM disk associated with the image, if any. Only applicable for machine images.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** -The device name of the root device (for example,
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- */ -@property (nonatomic, assign) AWSEC2DeviceType rootDeviceType; - -/** -Specifies whether enhanced networking is enabled.
- */ -@property (nonatomic, strong) NSString *sriovNetSupport; - -/** -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 reason for the state change.
- */ -@property (nonatomic, strong) AWSEC2StateReason *stateReason; - -/** -Any tags assigned to the image.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The type of virtualization of the AMI.
- */ -@property (nonatomic, assign) AWSEC2VirtualizationType virtualizationType; - -@end - -/** -Describes an image attribute.
- */ -@interface AWSEC2ImageAttribute : AWSModel - - -/** -One or more block device mapping entries.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -A description for the AMI.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *detail; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -The kernel ID.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *kernelId; - -/** -One or more launch permissions.
- */ -@property (nonatomic, strong) NSArray *launchPermissions; - -/** -One or more product codes.
- */ -@property (nonatomic, strong) NSArray *productCodes; - -/** -The RAM disk ID.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *ramdiskId; - -/** -The value to use for a resource attribute.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *sriovNetSupport; - -@end - -/** - - */ -@interface AWSEC2ImportInstanceLaunchSpecification : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSString *additionalInfo; - -/** -The architecture of the instance.
- */ -@property (nonatomic, assign) AWSEC2ArchitectureValues architecture; - -/** - - */ -@property (nonatomic, strong) NSArray *groupIds; - -/** -One or more security group names.
- */ -@property (nonatomic, strong) NSArray *groupNames; - -/** -Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- */ -@property (nonatomic, assign) AWSEC2ShutdownBehavior instanceInitiatedShutdownBehavior; - -/** -The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** - - */ -@property (nonatomic, strong) NSNumber *monitoring; - -/** -Describes the placement for the instance.
- */ -@property (nonatomic, strong) AWSEC2Placement *placement; - -/** -[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.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -[EC2-VPC] The ID of the subnet to launch the instance into.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -User data to be made available to the instance.
- */ -@property (nonatomic, strong) NSString *userData; - -@end - -/** - - */ -@interface AWSEC2ImportInstanceRequest : AWSRequest - - -/** -A description for the instance being imported.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSArray *diskImages; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** - - */ -@property (nonatomic, strong) AWSEC2ImportInstanceLaunchSpecification *launchSpecification; - -/** -The instance operating system.
- */ -@property (nonatomic, assign) AWSEC2PlatformValues platform; - -@end - -/** - - */ -@interface AWSEC2ImportInstanceResult : AWSModel - - -/** -Describes a conversion task.
- */ -@property (nonatomic, strong) AWSEC2ConversionTask *conversionTask; - -@end - -/** - - */ -@interface AWSEC2ImportInstanceTaskDetails : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The instance operating system.
- */ -@property (nonatomic, assign) AWSEC2PlatformValues platform; - -/** - - */ -@property (nonatomic, strong) NSArray *volumes; - -@end - -/** -Describes an import volume task.
- Required parameters: [BytesConverted, AvailabilityZone, Image, Volume, Status] - */ -@interface AWSEC2ImportInstanceVolumeDetailItem : AWSModel - - -/** -The Availability Zone where the resulting instance will reside.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The number of bytes converted so far.
- */ -@property (nonatomic, strong) NSNumber *bytesConverted; - -/** - - */ -@property (nonatomic, strong) NSString *detail; - -/** -The image.
- */ -@property (nonatomic, strong) AWSEC2DiskImageDescription *image; - -/** -The status of the import of this particular disk image.
- */ -@property (nonatomic, strong) NSString *status; - -/** -The status information or errors related to the disk image.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -/** -The volume.
- */ -@property (nonatomic, strong) AWSEC2DiskImageVolumeDescription *volume; - -@end - -/** - - */ -@interface AWSEC2ImportKeyPairRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -A unique name for the key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -/** -The public key. You must base64 encode the public key material before sending it to AWS.
- */ -@property (nonatomic, strong) NSData *publicKeyMaterial; - -@end - -/** - - */ -@interface AWSEC2ImportKeyPairResult : AWSModel - - -/** -The MD5 public key fingerprint as specified in section 4 of RFC 4716.
- */ -@property (nonatomic, strong) NSString *keyFingerprint; - -/** -The key pair name you provided.
- */ -@property (nonatomic, strong) NSString *keyName; - -@end - -/** - - */ -@interface AWSEC2ImportVolumeRequest : AWSRequest - - -/** -The Availability Zone for the resulting Amazon EBS volume.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -An optional description for the volume being imported.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** - - */ -@property (nonatomic, strong) AWSEC2DiskImageDetail *image; - -/** -Describes an Amazon EBS volume.
- */ -@property (nonatomic, strong) AWSEC2VolumeDetail *volume; - -@end - -/** - - */ -@interface AWSEC2ImportVolumeResult : AWSModel - - -/** -Describes a conversion task.
- */ -@property (nonatomic, strong) AWSEC2ConversionTask *conversionTask; - -@end - -/** -Describes an import volume task.
- Required parameters: [BytesConverted, AvailabilityZone, Image, Volume] - */ -@interface AWSEC2ImportVolumeTaskDetails : AWSModel - - -/** -The Availability Zone where the resulting volume will reside.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The number of bytes converted so far.
- */ -@property (nonatomic, strong) NSNumber *bytesConverted; - -/** -The description you provided when starting the import volume task.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The image.
- */ -@property (nonatomic, strong) AWSEC2DiskImageDescription *image; - -/** -The volume.
- */ -@property (nonatomic, strong) AWSEC2DiskImageVolumeDescription *volume; - -@end - -/** -Describes an instance.
- */ -@interface AWSEC2Instance : AWSModel - - -/** -The AMI launch index, which can be used to find this instance in the launch group.
- */ -@property (nonatomic, strong) NSNumber *amiLaunchIndex; - -/** -The architecture of the image.
- */ -@property (nonatomic, assign) AWSEC2ArchitectureValues architecture; - -/** -Any block device mapping entries for the instance.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -The idempotency token you provided when you launched the instance.
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *ebsOptimized; - -/** -The hypervisor type of the instance.
- */ -@property (nonatomic, assign) AWSEC2HypervisorType hypervisor; - -/** -The IAM instance profile associated with the instance.
- */ -@property (nonatomic, strong) AWSEC2IamInstanceProfile *iamInstanceProfile; - -/** -The ID of the AMI used to launch the instance.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -Indicates whether this is a Spot Instance.
- */ -@property (nonatomic, assign) AWSEC2InstanceLifecycleType instanceLifecycle; - -/** -The instance type.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** -The kernel associated with this instance.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -The name of the key pair, if this instance was launched with an associated key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -/** -The time the instance was launched.
- */ -@property (nonatomic, strong) NSDate *launchTime; - -/** -The monitoring information for the instance.
- */ -@property (nonatomic, strong) AWSEC2Monitoring *monitoring; - -/** -[EC2-VPC] One or more network interfaces for the instance.
- */ -@property (nonatomic, strong) NSArray *networkInterfaces; - -/** -The location where the instance launched.
- */ -@property (nonatomic, strong) AWSEC2Placement *placement; - -/** -The value is Windows for Windows instances; otherwise blank.
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 private IP address assigned to the instance.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -The product codes attached to this instance.
- */ -@property (nonatomic, strong) NSArray *productCodes; - -/** -The public DNS name assigned to the instance. This name is not available until the instance enters the running state.
The public IP address assigned to the instance.
- */ -@property (nonatomic, strong) NSString *publicIpAddress; - -/** -The RAM disk associated with this instance.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** -The root device name (for example, /dev/sda1).
The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- */ -@property (nonatomic, assign) AWSEC2DeviceType rootDeviceType; - -/** -One or more security groups for the instance.
- */ -@property (nonatomic, strong) NSArray *securityGroups; - -/** -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 ID of the Spot Instance request.
- */ -@property (nonatomic, strong) NSString *spotInstanceRequestId; - -/** -Specifies whether enhanced networking is enabled.
- */ -@property (nonatomic, strong) NSString *sriovNetSupport; - -/** -The current state of the instance.
- */ -@property (nonatomic, strong) AWSEC2InstanceState *state; - -/** -The reason for the most recent state transition.
- */ -@property (nonatomic, strong) AWSEC2StateReason *stateReason; - -/** -The reason for the most recent state transition. This might be an empty string.
- */ -@property (nonatomic, strong) NSString *stateTransitionReason; - -/** -The ID of the subnet in which the instance is running.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -Any tags assigned to the instance.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The virtualization type of the instance.
- */ -@property (nonatomic, assign) AWSEC2VirtualizationType virtualizationType; - -/** -The ID of the VPC in which the instance is running.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes an instance attribute.
- */ -@interface AWSEC2InstanceAttribute : AWSModel - - -/** -The block device mapping of the instance.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
Indicates whether the instance is optimized for EBS I/O.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *ebsOptimized; - -/** -The security groups associated with the instance.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *instanceInitiatedShutdownBehavior; - -/** -The instance type.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *instanceType; - -/** -The kernel ID.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *kernelId; - -/** -A list of product codes.
- */ -@property (nonatomic, strong) NSArray *productCodes; - -/** -The RAM disk ID.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *ramdiskId; - -/** -The name of the root device (for example, /dev/sda1).
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 value to use for a resource attribute.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *sriovNetSupport; - -/** -The Base64-encoded MIME user data.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *userData; - -@end - -/** -Describes a block device mapping.
- */ -@interface AWSEC2InstanceBlockDeviceMapping : AWSModel - - -/** -The device name exposed to the instance (for example,
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
- */ -@property (nonatomic, strong) AWSEC2EbsInstanceBlockDevice *ebs; - -@end - -/** -Describes a block device mapping entry.
- */ -@interface AWSEC2InstanceBlockDeviceMappingSpecification : AWSModel - - -/** -The device name exposed to the instance (for example,
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
- */ -@property (nonatomic, strong) AWSEC2EbsInstanceBlockDeviceSpecification *ebs; - -/** -suppress the specified device included in the block device mapping.
- */ -@property (nonatomic, strong) NSString *noDevice; - -/** -The virtual device name.
- */ -@property (nonatomic, strong) NSString *virtualName; - -@end - -/** -Describes a Reserved Instance listing state.
- */ -@interface AWSEC2InstanceCount : AWSModel - - -/** -he number of listed Reserved Instances in the state specified by the state.
The states of the listed Reserved Instances.
- */ -@property (nonatomic, assign) AWSEC2ListingState state; - -@end - -/** -Describes an instance export task.
- */ -@interface AWSEC2InstanceExportDetails : AWSModel - - -/** -The ID of the resource being exported.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The target virtualization environment.
- */ -@property (nonatomic, assign) AWSEC2ExportEnvironment targetEnvironment; - -@end - -/** -Describes the monitoring information of the instance.
- */ -@interface AWSEC2InstanceMonitoring : AWSModel - - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The monitoring information.
- */ -@property (nonatomic, strong) AWSEC2Monitoring *monitoring; - -@end - -/** -Describes a network interface.
- */ -@interface AWSEC2InstanceNetworkInterface : AWSModel - - -/** -The association information for an Elastic IP associated with the network interface.
- */ -@property (nonatomic, strong) AWSEC2InstanceNetworkInterfaceAssociation *association; - -/** -The network interface attachment.
- */ -@property (nonatomic, strong) AWSEC2InstanceNetworkInterfaceAttachment *attachment; - -/** -The description.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -One or more security groups.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -The MAC address.
- */ -@property (nonatomic, strong) NSString *macAddress; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The ID of the AWS account that created the network interface.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The private DNS name.
- */ -@property (nonatomic, strong) NSString *privateDnsName; - -/** -The IP address of the network interface within the subnet.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -The private IP addresses associated with the network interface.
- */ -@property (nonatomic, strong) NSArray *privateIpAddresses; - -/** -Indicates whether to validate network traffic to or from this network interface.
- */ -@property (nonatomic, strong) NSNumber *sourceDestCheck; - -/** -The status of the network interface.
- */ -@property (nonatomic, assign) AWSEC2NetworkInterfaceStatus status; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes association information for an Elastic IP address.
- */ -@interface AWSEC2InstanceNetworkInterfaceAssociation : AWSModel - - -/** -The ID of the owner of the Elastic IP address.
- */ -@property (nonatomic, strong) NSString *ipOwnerId; - -/** -The public DNS name.
- */ -@property (nonatomic, strong) NSString *publicDnsName; - -/** -The public IP address or Elastic IP address bound to the network interface.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** -Describes a network interface attachment.
- */ -@interface AWSEC2InstanceNetworkInterfaceAttachment : AWSModel - - -/** -The time stamp when the attachment initiated.
- */ -@property (nonatomic, strong) NSDate *attachTime; - -/** -The ID of the network interface attachment.
- */ -@property (nonatomic, strong) NSString *attachmentId; - -/** -Indicates whether the network interface is deleted when the instance is terminated.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -/** -The index of the device on the instance for the network interface attachment.
- */ -@property (nonatomic, strong) NSNumber *deviceIndex; - -/** -The attachment state.
- */ -@property (nonatomic, assign) AWSEC2AttachmentStatus status; - -@end - -/** -Describes a network interface.
- */ -@interface AWSEC2InstanceNetworkInterfaceSpecification : AWSModel - - -/** -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.
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.
The description of the network interface. Applies only if creating a network interface when launching an instance.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *deviceIndex; - -/** -The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The private IP address of the network interface. Applies only if creating a network interface when launching an instance.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.
- */ -@property (nonatomic, strong) NSArray *privateIpAddresses; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *secondaryPrivateIpAddressCount; - -/** -The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** -Describes a private IP address.
- */ -@interface AWSEC2InstancePrivateIpAddress : AWSModel - - -/** -The association information for an Elastic IP address for the network interface.
- */ -@property (nonatomic, strong) AWSEC2InstanceNetworkInterfaceAssociation *association; - -/** -Indicates whether this IP address is the primary private IP address of the network interface.
- */ -@property (nonatomic, strong) NSNumber *primary; - -/** -The private DNS name.
- */ -@property (nonatomic, strong) NSString *privateDnsName; - -/** -The private IP address of the network interface.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -@end - -/** -Describes the current state of the instance.
- */ -@interface AWSEC2InstanceState : AWSModel - - -/** -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.
- */ -@property (nonatomic, assign) AWSEC2InstanceStateName name; - -@end - -/** -Describes an instance state change.
- */ -@interface AWSEC2InstanceStateChange : AWSModel - - -/** -The current state of the instance.
- */ -@property (nonatomic, strong) AWSEC2InstanceState *currentState; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The previous state of the instance.
- */ -@property (nonatomic, strong) AWSEC2InstanceState *previousState; - -@end - -/** -Describes the status of an instance.
- */ -@interface AWSEC2InstanceStatus : AWSModel - - -/** -The Availability Zone of the instance.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -Extra information regarding events associated with the instance.
- */ -@property (nonatomic, strong) NSArray *events; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
- */ -@property (nonatomic, strong) AWSEC2InstanceStatusSummary *instanceStatus; - -/** -Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
- */ -@property (nonatomic, strong) AWSEC2InstanceStatusSummary *systemStatus; - -@end - -/** -Describes the instance status.
- */ -@interface AWSEC2InstanceStatusDetails : AWSModel - - -/** -The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
- */ -@property (nonatomic, strong) NSDate *impairedSince; - -/** -The type of instance status.
- */ -@property (nonatomic, assign) AWSEC2StatusName name; - -/** -The status.
- */ -@property (nonatomic, assign) AWSEC2StatusType status; - -@end - -/** -Describes an instance event.
- */ -@interface AWSEC2InstanceStatusEvent : AWSModel - - -/** -The associated code of the event.
- */ -@property (nonatomic, assign) AWSEC2EventCode code; - -/** -A description of the event.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The latest scheduled end time for the event.
- */ -@property (nonatomic, strong) NSDate *notAfter; - -/** -The earliest scheduled start time for the event.
- */ -@property (nonatomic, strong) NSDate *notBefore; - -@end - -/** -Describes the status of an instance.
- */ -@interface AWSEC2InstanceStatusSummary : AWSModel - - -/** -The system instance health or application instance health.
- */ -@property (nonatomic, strong) NSArray *details; - -/** -The status.
- */ -@property (nonatomic, assign) AWSEC2SummaryStatus status; - -@end - -/** -Describes an Internet gateway.
- */ -@interface AWSEC2InternetGateway : AWSModel - - -/** -Any VPCs attached to the Internet gateway.
- */ -@property (nonatomic, strong) NSArray *attachments; - -/** -The ID of the Internet gateway.
- */ -@property (nonatomic, strong) NSString *internetGatewayId; - -/** -Any tags assigned to the Internet gateway.
- */ -@property (nonatomic, strong) NSArray *tags; - -@end - -/** -Describes the attachment of a VPC to an Internet gateway.
- */ -@interface AWSEC2InternetGatewayAttachment : AWSModel - - -/** -The current state of the attachment.
- */ -@property (nonatomic, assign) AWSEC2AttachmentStatus state; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes a security group rule.
- */ -@interface AWSEC2IpPermission : AWSModel - - -/** -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 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.
One or more IP ranges.
- */ -@property (nonatomic, strong) NSArray *ipRanges; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *userIdGroupPairs; - -@end - -/** -Describes an IP range.
- */ -@interface AWSEC2IpRange : AWSModel - - -/** -The CIDR range. You can either specify a CIDR range or a source security group, not both.
- */ -@property (nonatomic, strong) NSString *cidrIp; - -@end - -/** -Describes a key pair.
- */ -@interface AWSEC2KeyPair : AWSModel - - -/** -The SHA-1 digest of the DER encoded private key.
- */ -@property (nonatomic, strong) NSString *keyFingerprint; - -/** -An unencrypted PEM encoded RSA private key.
- */ -@property (nonatomic, strong) NSString *keyMaterial; - -/** -The name of the key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -@end - -/** -Describes a key pair.
- */ -@interface AWSEC2KeyPairInfo : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *keyFingerprint; - -/** -The name of the key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -@end - -/** - - */ -@interface AWSEC2LatestDhcpConfiguration : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSString *key; - -/** - - */ -@property (nonatomic, strong) NSArray *values; - -@end - -/** -Describes a launch permission.
- */ -@interface AWSEC2LaunchPermission : AWSModel - - -/** -The name of the group.
- */ -@property (nonatomic, assign) AWSEC2PermissionGroup group; - -/** -The AWS account ID.
- */ -@property (nonatomic, strong) NSString *userId; - -@end - -/** -Describes a launch permission modification.
- */ -@interface AWSEC2LaunchPermissionModifications : AWSModel - - -/** -The AWS account ID to add to the list of launch permissions for the AMI.
- */ -@property (nonatomic, strong) NSArray *add; - -/** -The AWS account ID to remove from the list of launch permissions for the AMI.
- */ -@property (nonatomic, strong) NSArray *remove; - -@end - -/** -Describes the launch specification of a Spot Instance.
- */ -@interface AWSEC2LaunchSpecification : AWSModel - - -/** -Deprecated.
- */ -@property (nonatomic, strong) NSString *addressingType; - -/** -One or more block device mapping entries.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -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
The IAM instance profile.
- */ -@property (nonatomic, strong) AWSEC2IamInstanceProfileSpecification *iamInstanceProfile; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -The instance type.
Default: m1.small
The ID of the kernel.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -The name of the key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -/** -Describes the monitoring for the instance.
- */ -@property (nonatomic, strong) AWSEC2RunInstancesMonitoringEnabled *monitoring; - -/** -One or more network interfaces.
- */ -@property (nonatomic, strong) NSArray *networkInterfaces; - -/** -The placement information for the instance.
- */ -@property (nonatomic, strong) AWSEC2SpotPlacement *placement; - -/** -The ID of the RAM disk.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *securityGroups; - -/** -The ID of the subnet in which to launch the Spot Instance.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -The Base64-encoded MIME user data to make available to the instances.
- */ -@property (nonatomic, strong) NSString *userData; - -@end - -/** - - */ -@interface AWSEC2ModifyImageAttributeRequest : AWSRequest - - -/** -The name of the attribute to modify.
- */ -@property (nonatomic, strong) NSString *attribute; - -/** -A description for the AMI.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** - - */ -@property (nonatomic, strong) AWSEC2LaunchPermissionModifications *launchPermission; - -/** -The operation type.
- */ -@property (nonatomic, strong) NSString *operationType; - -/** -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.
One or more user groups. This is only valid when modifying the launchPermission attribute.
One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
The value of the attribute being modified. This is only valid when modifying the description attribute.
The name of the attribute.
- */ -@property (nonatomic, assign) AWSEC2InstanceAttributeName 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.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
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.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *ebsOptimized; - -/** -[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.
The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *instanceInitiatedShutdownBehavior; - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *kernel; - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *ramdisk; - -/** -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.
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.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *sriovNetSupport; - -/** -Changes the instance's user data to the specified value.
- */ -@property (nonatomic, strong) AWSEC2BlobAttributeValue *userData; - -/** -A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.
Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
- */ -@property (nonatomic, strong) AWSEC2NetworkInterfaceAttachmentChanges *attachment; - -/** -A description for the network interface.
- */ -@property (nonatomic, strong) AWSEC2AttributeValue *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -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.
A unique, case-sensitive token you provide to ensure idempotency of your modification request.
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -The IDs of the Reserved Instances to modify.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesIds; - -/** -The configuration settings for the Reserved Instances to modify.
- */ -@property (nonatomic, strong) NSArray *targetConfigurations; - -@end - -/** - - */ -@interface AWSEC2ModifyReservedInstancesResult : AWSModel - - -/** -The ID for the modification.
- */ -@property (nonatomic, strong) NSString *reservedInstancesModificationId; - -@end - -/** - - */ -@interface AWSEC2ModifySnapshotAttributeRequest : AWSRequest - - -/** -The snapshot attribute to modify.
- */ -@property (nonatomic, assign) AWSEC2SnapshotAttributeName attribute; - -/** -A JSON representation of the snapshot attribute modification.
- */ -@property (nonatomic, strong) AWSEC2CreateVolumePermissionModifications *createVolumePermission; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The group to modify for the snapshot.
- */ -@property (nonatomic, strong) NSArray *groupNames; - -/** -The type of operation to perform to the attribute.
- */ -@property (nonatomic, strong) NSString *operationType; - -/** -The ID of the snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -/** -The account ID to modify for the snapshot.
- */ -@property (nonatomic, strong) NSArray *userIds; - -@end - -/** - - */ -@interface AWSEC2ModifySubnetAttributeRequest : AWSRequest - - -/** -The value to use when a resource attribute accepts a Boolean value.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *mapPublicIpOnLaunch; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** - - */ -@interface AWSEC2ModifyVolumeAttributeRequest : AWSRequest - - -/** -Indicates whether the volume should be auto-enabled for I/O operations.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *autoEnableIO; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** - - */ -@interface AWSEC2ModifyVpcAttributeRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *enableDnsHostnames; - -/** -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.
- */ -@property (nonatomic, strong) AWSEC2AttributeBooleanValue *enableDnsSupport; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** - - */ -@interface AWSEC2MonitorInstancesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** - - */ -@interface AWSEC2MonitorInstancesResult : AWSModel - - -/** -Monitoring information for one or more instances.
- */ -@property (nonatomic, strong) NSArray *instanceMonitorings; - -@end - -/** -Describes the monitoring for the instance.
- */ -@interface AWSEC2Monitoring : AWSModel - - -/** -Indicates whether monitoring is enabled for the instance.
- */ -@property (nonatomic, assign) AWSEC2MonitoringState state; - -@end - -/** -Describes a network ACL.
- */ -@interface AWSEC2NetworkAcl : AWSModel - - -/** -Any associations between the network ACL and one or more subnets
- */ -@property (nonatomic, strong) NSArray *associations; - -/** -One or more entries (rules) in the network ACL.
- */ -@property (nonatomic, strong) NSArray *entries; - -/** -Indicates whether this is the default network ACL for the VPC.
- */ -@property (nonatomic, strong) NSNumber *isDefault; - -/** -The ID of the network ACL.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -/** -Any tags assigned to the network ACL.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the VPC for the network ACL.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes an association between a network ACL and a subnet.
- */ -@interface AWSEC2NetworkAclAssociation : AWSModel - - -/** -The ID of the association between a network ACL and a subnet.
- */ -@property (nonatomic, strong) NSString *networkAclAssociationId; - -/** -The ID of the network ACL.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** -Describes an entry in a network ACL.
- */ -@interface AWSEC2NetworkAclEntry : AWSModel - - -/** -The network range to allow or deny, in CIDR notation.
- */ -@property (nonatomic, strong) NSString *cidrBlock; - -/** -Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
- */ -@property (nonatomic, strong) NSNumber *egress; - -/** -ICMP protocol: The ICMP type and code.
- */ -@property (nonatomic, strong) AWSEC2IcmpTypeCode *icmpTypeCode; - -/** -TCP or UDP protocols: The range of ports the rule applies to.
- */ -@property (nonatomic, strong) AWSEC2PortRange *portRange; - -/** -The protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
- */ -@property (nonatomic, assign) AWSEC2RuleAction ruleAction; - -/** -The rule number for the entry. ACL entries are processed in ascending order by rule number.
- */ -@property (nonatomic, strong) NSNumber *ruleNumber; - -@end - -/** -Describes a network interface.
- */ -@interface AWSEC2NetworkInterface : AWSModel - - -/** -The association information for an Elastic IP associated with the network interface.
- */ -@property (nonatomic, strong) AWSEC2NetworkInterfaceAssociation *association; - -/** -The network interface attachment.
- */ -@property (nonatomic, strong) AWSEC2NetworkInterfaceAttachment *attachment; - -/** -The Availability Zone.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -A description.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -Any security groups for the network interface.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -The MAC address.
- */ -@property (nonatomic, strong) NSString *macAddress; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The AWS account ID of the owner of the network interface.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The private DNS name.
- */ -@property (nonatomic, strong) NSString *privateDnsName; - -/** -The IP address of the network interface within the subnet.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -The private IP addresses associated with the network interface.
- */ -@property (nonatomic, strong) NSArray *privateIpAddresses; - -/** -The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
- */ -@property (nonatomic, strong) NSString *requesterId; - -/** -Indicates whether the network interface is being managed by AWS.
- */ -@property (nonatomic, strong) NSNumber *requesterManaged; - -/** -Indicates whether traffic to or from the instance is validated.
- */ -@property (nonatomic, strong) NSNumber *sourceDestCheck; - -/** -The status of the network interface.
- */ -@property (nonatomic, assign) AWSEC2NetworkInterfaceStatus status; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -Any tags assigned to the network interface.
- */ -@property (nonatomic, strong) NSArray *tagSet; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes association information for an Elastic IP address.
- */ -@interface AWSEC2NetworkInterfaceAssociation : AWSModel - - -/** -The allocation ID.
- */ -@property (nonatomic, strong) NSString *allocationId; - -/** -The association ID.
- */ -@property (nonatomic, strong) NSString *associationId; - -/** -The ID of the Elastic IP address owner.
- */ -@property (nonatomic, strong) NSString *ipOwnerId; - -/** -The public DNS name.
- */ -@property (nonatomic, strong) NSString *publicDnsName; - -/** -The address of the Elastic IP address bound to the network interface.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** -Describes a network interface attachment.
- */ -@interface AWSEC2NetworkInterfaceAttachment : AWSModel - - -/** -The timestamp indicating when the attachment initiated.
- */ -@property (nonatomic, strong) NSDate *attachTime; - -/** -The ID of the network interface attachment.
- */ -@property (nonatomic, strong) NSString *attachmentId; - -/** -Indicates whether the network interface is deleted when the instance is terminated.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -/** -The device index of the network interface attachment on the instance.
- */ -@property (nonatomic, strong) NSNumber *deviceIndex; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The AWS account ID of the owner of the instance.
- */ -@property (nonatomic, strong) NSString *instanceOwnerId; - -/** -The attachment state.
- */ -@property (nonatomic, assign) AWSEC2AttachmentStatus status; - -@end - -/** -Describes an attachment change.
- */ -@interface AWSEC2NetworkInterfaceAttachmentChanges : AWSModel - - -/** -The ID of the network interface attachment.
- */ -@property (nonatomic, strong) NSString *attachmentId; - -/** -Indicates whether the network interface is deleted when the instance is terminated.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -@end - -/** -Describes the private IP address of a network interface.
- */ -@interface AWSEC2NetworkInterfacePrivateIpAddress : AWSModel - - -/** -The association information for an Elastic IP address associated with the network interface.
- */ -@property (nonatomic, strong) AWSEC2NetworkInterfaceAssociation *association; - -/** -Indicates whether this IP address is the primary private IP address of the network interface.
- */ -@property (nonatomic, strong) NSNumber *primary; - -/** -The private DNS name.
- */ -@property (nonatomic, strong) NSString *privateDnsName; - -/** -The private IP address.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -@end - -/** -Describes the placement for the instance.
- */ -@interface AWSEC2Placement : AWSModel - - -/** -The Availability Zone of the instance.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The name of the placement group the instance is in (for cluster compute instances).
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -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 a placement group.
- */ -@interface AWSEC2PlacementGroup : AWSModel - - -/** -The name of the placement group.
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -The state of the placement group.
- */ -@property (nonatomic, assign) AWSEC2PlacementGroupState state; - -/** -The placement strategy.
- */ -@property (nonatomic, assign) AWSEC2PlacementStrategy strategy; - -@end - -/** -Describes a range of ports.
- */ -@interface AWSEC2PortRange : AWSModel - - -/** -The first port in the range.
- */ -@property (nonatomic, strong) NSNumber *from; - -/** -The last port in the range.
- */ -@property (nonatomic, strong) NSNumber *to; - -@end - -/** -Describes the price for a Reserved Instance.
- */ -@interface AWSEC2PriceSchedule : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *active; - -/** -The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The fixed price for the term.
- */ -@property (nonatomic, strong) NSNumber *price; - -/** -The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
- */ -@property (nonatomic, strong) NSNumber *term; - -@end - -/** -Describes the price for a Reserved Instance.
- */ -@interface AWSEC2PriceScheduleSpecification : AWSModel - - -/** -The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The fixed price for the term.
- */ -@property (nonatomic, strong) NSNumber *price; - -/** -The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
- */ -@property (nonatomic, strong) NSNumber *term; - -@end - -/** -Describes a Reserved Instance offering.
- */ -@interface AWSEC2PricingDetail : AWSModel - - -/** -The number of instances available for the price.
- */ -@property (nonatomic, strong) NSNumber *count; - -/** -The price per instance.
- */ -@property (nonatomic, strong) NSNumber *price; - -@end - -/** -Describes a secondary private IP address for a network interface.
- Required parameters: [PrivateIpAddress] - */ -@interface AWSEC2PrivateIpAddressSpecification : AWSModel - - -/** -Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
- */ -@property (nonatomic, strong) NSNumber *primary; - -/** -The private IP addresses.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -@end - -/** -Describes a product code.
- */ -@interface AWSEC2ProductCode : AWSModel - - -/** -The product code.
- */ -@property (nonatomic, strong) NSString *productCodeId; - -/** -The type of product code.
- */ -@property (nonatomic, assign) AWSEC2ProductCodeValues productCodeType; - -@end - -/** -Describes a virtual private gateway propagating route.
- */ -@interface AWSEC2PropagatingVgw : AWSModel - - -/** -The ID of the virtual private gateway (VGW).
- */ -@property (nonatomic, strong) NSString *gatewayId; - -@end - -/** - - */ -@interface AWSEC2PurchaseReservedInstancesOfferingRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The number of Reserved Instances to purchase.
- */ -@property (nonatomic, strong) NSNumber *instanceCount; - -/** -Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
- */ -@property (nonatomic, strong) AWSEC2ReservedInstanceLimitPrice *limitPrice; - -/** -The ID of the Reserved Instance offering to purchase.
- */ -@property (nonatomic, strong) NSString *reservedInstancesOfferingId; - -@end - -/** - - */ -@interface AWSEC2PurchaseReservedInstancesOfferingResult : AWSModel - - -/** -The IDs of the purchased Reserved Instances.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -@end - -/** - - */ -@interface AWSEC2RebootInstancesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** -Describes a recurring charge.
- */ -@interface AWSEC2RecurringCharge : AWSModel - - -/** -The amount of the recurring charge.
- */ -@property (nonatomic, strong) NSNumber *amount; - -/** -The frequency of the recurring charge.
- */ -@property (nonatomic, assign) AWSEC2RecurringChargeFrequency frequency; - -@end - -/** -Describes a region.
- */ -@interface AWSEC2Region : AWSModel - - -/** -The region service endpoint.
- */ -@property (nonatomic, strong) NSString *endpoint; - -/** -The name of the region.
- */ -@property (nonatomic, strong) NSString *regionName; - -@end - -/** - - */ -@interface AWSEC2RegisterImageRequest : AWSRequest - - -/** -The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
One or more block device mapping entries.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -A description for your AMI.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The full path to your AMI manifest in Amazon S3 storage.
- */ -@property (nonatomic, strong) NSString *imageLocation; - -/** -The ID of the kernel.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
- */ -@property (nonatomic, strong) NSString *name; - -/** -The ID of the RAM disk.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** -The name of the root device (for example, /dev/sda1, or xvda).
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.
- */ -@property (nonatomic, strong) NSString *sriovNetSupport; - -/** -The type of virtualization.
Default: paravirtual
The ID of the newly registered AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -@end - -/** - - */ -@interface AWSEC2RejectVpcPeeringConnectionRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** - - */ -@interface AWSEC2RejectVpcPeeringConnectionResult : AWSModel - - -/** -Returns true if the request succeeds; otherwise, it returns an error.
[EC2-VPC] The allocation ID. Required for EC2-VPC.
- */ -@property (nonatomic, strong) NSString *allocationId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
- */ -@property (nonatomic, strong) NSString *publicIp; - -@end - -/** - - */ -@interface AWSEC2ReplaceNetworkAclAssociationRequest : AWSRequest - - -/** -The ID of the current association between the original network ACL and the subnet.
- */ -@property (nonatomic, strong) NSString *associationId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the new network ACL to associate with the subnet.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -@end - -/** - - */ -@interface AWSEC2ReplaceNetworkAclAssociationResult : AWSModel - - -/** -The ID of the new association.
- */ -@property (nonatomic, strong) NSString *latestAssociationId; - -@end - -/** - - */ -@interface AWSEC2ReplaceNetworkAclEntryRequest : AWSRequest - - -/** -The network range to allow or deny, in CIDR notation.
- */ -@property (nonatomic, strong) NSString *cidrBlock; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
- */ -@property (nonatomic, strong) NSNumber *egress; - -/** -ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.
- */ -@property (nonatomic, strong) AWSEC2IcmpTypeCode *icmpTypeCode; - -/** -The ID of the ACL.
- */ -@property (nonatomic, strong) NSString *networkAclId; - -/** -TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.
- */ -@property (nonatomic, strong) AWSEC2PortRange *portRange; - -/** -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.
- */ -@property (nonatomic, assign) AWSEC2RuleAction ruleAction; - -/** -The rule number of the entry to replace.
- */ -@property (nonatomic, strong) NSNumber *ruleNumber; - -@end - -/** - - */ -@interface AWSEC2ReplaceRouteRequest : AWSRequest - - -/** -The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of an Internet gateway or virtual private gateway.
- */ -@property (nonatomic, strong) NSString *gatewayId; - -/** -The ID of a NAT instance in your VPC.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The ID of a network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -/** -The ID of a VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** - - */ -@interface AWSEC2ReplaceRouteTableAssociationRequest : AWSRequest - - -/** -The association ID.
- */ -@property (nonatomic, strong) NSString *associationId; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the new route table to associate with the subnet.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -@end - -/** - - */ -@interface AWSEC2ReplaceRouteTableAssociationResult : AWSModel - - -/** -The ID of the new association.
- */ -@property (nonatomic, strong) NSString *latestAssociationId; - -@end - -/** - - */ -@interface AWSEC2ReplicateImageRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -A description for the new AMI in the destination region.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The name of the new AMI in the destination region.
- */ -@property (nonatomic, strong) NSString *name; - -/** -The ID of the AMI to copy.
- */ -@property (nonatomic, strong) NSString *sourceImageId; - -/** -The name of the region that contains the AMI to copy.
- */ -@property (nonatomic, strong) NSString *sourceRegion; - -@end - -/** - - */ -@interface AWSEC2ReplicateImageResult : AWSModel - - -/** -The ID of the new AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -@end - -/** - - */ -@interface AWSEC2ReplicateSnapshotRequest : AWSRequest - - -/** -The destination region of the snapshot copy operation. This parameter is required in the PresignedUrl.
A description for the new Amazon EBS snapshot.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 region that contains the snapshot to be copied.
- */ -@property (nonatomic, strong) NSString *sourceRegion; - -/** -The ID of the Amazon EBS snapshot to copy.
- */ -@property (nonatomic, strong) NSString *sourceSnapshotId; - -@end - -/** - - */ -@interface AWSEC2ReplicateSnapshotResult : AWSModel - - -/** -The ID of the new snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -@end - -/** - - */ -@interface AWSEC2ReportInstanceStatusRequest : AWSRequest - - -/** -Descriptive text about the health state of your instance.
- */ -@property (nonatomic, strong) NSString *detail; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The time at which the reported instance health state ended.
- */ -@property (nonatomic, strong) NSDate *endTime; - -/** -One or more instances.
- */ -@property (nonatomic, strong) NSArray *instances; - -/** -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]
The time at which the reported instance health state began.
- */ -@property (nonatomic, strong) NSDate *startTime; - -/** -The status of all instances listed.
- */ -@property (nonatomic, assign) AWSEC2ReportStatusType status; - -@end - -/** - - */ -@interface AWSEC2RequestSpotInstancesRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *availabilityZoneGroup; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The maximum number of Spot Instances to launch.
Default: 1
- */ -@property (nonatomic, strong) NSNumber *instanceCount; - -/** -The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
- */ -@property (nonatomic, strong) NSString *launchGroup; - -/** -Describes the launch specification of a Spot Instance.
- */ -@property (nonatomic, strong) AWSEC2RequestSpotLaunchSpecification *launchSpecification; - -/** -The maximum hourly price for any Spot Instance launched to fulfill the request.
- */ -@property (nonatomic, strong) NSString *spotPrice; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *validFrom; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *validUntil; - -@end - -/** - - */ -@interface AWSEC2RequestSpotInstancesResult : AWSModel - - -/** -Information about the Spot Instance request.
- */ -@property (nonatomic, strong) NSArray *spotInstanceRequests; - -@end - -/** -Describes the launch specification of a Spot Instance.
- */ -@interface AWSEC2RequestSpotLaunchSpecification : AWSModel - - -/** -Deprecated.
- */ -@property (nonatomic, strong) NSString *addressingType; - -/** -One or more block device mapping entries.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -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
The IAM instance profile.
- */ -@property (nonatomic, strong) AWSEC2IamInstanceProfileSpecification *iamInstanceProfile; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -The instance type.
Default: m1.small
The ID of the kernel.
- */ -@property (nonatomic, strong) NSString *kernelId; - -/** -The name of the key pair.
- */ -@property (nonatomic, strong) NSString *keyName; - -/** -Describes the monitoring for the instance.
- */ -@property (nonatomic, strong) AWSEC2RunInstancesMonitoringEnabled *monitoring; - -/** -One or more network interfaces.
- */ -@property (nonatomic, strong) NSArray *networkInterfaces; - -/** -The placement information for the instance.
- */ -@property (nonatomic, strong) AWSEC2SpotPlacement *placement; - -/** -The ID of the RAM disk.
- */ -@property (nonatomic, strong) NSString *ramdiskId; - -/** - - */ -@property (nonatomic, strong) NSArray *securityGroupIds; - -/** - - */ -@property (nonatomic, strong) NSArray *securityGroups; - -/** -The ID of the subnet in which to launch the Spot Instance.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -The Base64-encoded MIME user data to make available to the instances.
- */ -@property (nonatomic, strong) NSString *userData; - -@end - -/** -Describes a reservation.
- */ -@interface AWSEC2Reservation : AWSModel - - -/** -One or more security groups.
- */ -@property (nonatomic, strong) NSArray *groups; - -/** -One or more instances.
- */ -@property (nonatomic, strong) NSArray *instances; - -/** -The ID of the AWS account that owns the reservation.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
- */ -@property (nonatomic, strong) NSString *requesterId; - -/** -The ID of the reservation.
- */ -@property (nonatomic, strong) NSString *reservationId; - -@end - -/** -Describes the limit price of a Reserved Instance offering.
- */ -@interface AWSEC2ReservedInstanceLimitPrice : AWSModel - - -/** -Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
- */ -@property (nonatomic, strong) NSNumber *amount; - -/** -The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
Describes a Reserved Instance.
- */ -@interface AWSEC2ReservedInstances : AWSModel - - -/** -The Availability Zone in which the Reserved Instance can be used.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -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 duration of the Reserved Instance, in seconds.
- */ -@property (nonatomic, strong) NSNumber *duration; - -/** -The time when the Reserved Instance expires.
- */ -@property (nonatomic, strong) NSDate *end; - -/** -The purchase price of the Reserved Instance.
- */ -@property (nonatomic, strong) NSNumber *fixedPrice; - -/** -The number of Reserved Instances purchased.
- */ -@property (nonatomic, strong) NSNumber *instanceCount; - -/** -The tenancy of the reserved instance.
- */ -@property (nonatomic, assign) AWSEC2Tenancy instanceTenancy; - -/** -The instance type on which the Reserved Instance can be used.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** -The Reserved Instance offering type.
- */ -@property (nonatomic, assign) AWSEC2OfferingTypeValues offeringType; - -/** -The Reserved Instance description.
- */ -@property (nonatomic, assign) AWSEC2RIProductDescription productDescription; - -/** -The recurring charge tag assigned to the resource.
- */ -@property (nonatomic, strong) NSArray *recurringCharges; - -/** -The ID of the Reserved Instance.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -/** -The date and time the Reserved Instance started.
- */ -@property (nonatomic, strong) NSDate *start; - -/** -The state of the Reserved Instance purchase.
- */ -@property (nonatomic, assign) AWSEC2ReservedInstanceState state; - -/** -Any tags assigned to the resource.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The usage price of the Reserved Instance, per hour.
- */ -@property (nonatomic, strong) NSNumber *usagePrice; - -@end - -/** -Describes the configuration settings for the modified Reserved Instances.
- */ -@interface AWSEC2ReservedInstancesConfiguration : AWSModel - - -/** -The Availability Zone for the modified Reserved Instances.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The number of modified Reserved Instances.
- */ -@property (nonatomic, strong) NSNumber *instanceCount; - -/** -The instance type for the modified Reserved Instances.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** -The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
- */ -@property (nonatomic, strong) NSString *platform; - -@end - -/** -Describes the ID of a Reserved Instance.
- */ -@interface AWSEC2ReservedInstancesId : AWSModel - - -/** -The ID of the Reserved Instance.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -@end - -/** -Describes a Reserved Instance listing.
- */ -@interface AWSEC2ReservedInstancesListing : AWSModel - - -/** -The idempotency token you provided when you created the listing.
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -The time the listing was created.
- */ -@property (nonatomic, strong) NSDate *createDate; - -/** -The number of instances in this state.
- */ -@property (nonatomic, strong) NSArray *instanceCounts; - -/** -The price of the Reserved Instance listing.
- */ -@property (nonatomic, strong) NSArray *priceSchedules; - -/** -The ID of the Reserved Instance.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -/** -The ID of the Reserved Instance listing.
- */ -@property (nonatomic, strong) NSString *reservedInstancesListingId; - -/** -The status of the Reserved Instance listing.
- */ -@property (nonatomic, assign) AWSEC2ListingStatus status; - -/** -The reason for the current status of the Reserved Instance listing. The response can be blank.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -/** -Any tags assigned to the resource.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The last modified timestamp of the listing.
- */ -@property (nonatomic, strong) NSDate *updateDate; - -@end - -/** -Describes a Reserved Instance modification.
- */ -@interface AWSEC2ReservedInstancesModification : AWSModel - - -/** -A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -The time when the modification request was created.
- */ -@property (nonatomic, strong) NSDate *createDate; - -/** -The time for the modification to become effective.
- */ -@property (nonatomic, strong) NSDate *effectiveDate; - -/** -Contains target configurations along with their corresponding new Reserved Instance IDs.
- */ -@property (nonatomic, strong) NSArray *modificationResults; - -/** -The IDs of one or more Reserved Instances.
- */ -@property (nonatomic, strong) NSArray *reservedInstancesIds; - -/** -A unique ID for the Reserved Instance modification.
- */ -@property (nonatomic, strong) NSString *reservedInstancesModificationId; - -/** -The status of the Reserved Instances modification request.
- */ -@property (nonatomic, strong) NSString *status; - -/** -The reason for the status.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -/** -The time when the modification request was last updated.
- */ -@property (nonatomic, strong) NSDate *updateDate; - -@end - -/** - - */ -@interface AWSEC2ReservedInstancesModificationResult : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *reservedInstancesId; - -/** -The target Reserved Instances configurations supplied as part of the modification request.
- */ -@property (nonatomic, strong) AWSEC2ReservedInstancesConfiguration *targetConfiguration; - -@end - -/** -Describes a Reserved Instance offering.
- */ -@interface AWSEC2ReservedInstancesOffering : AWSModel - - -/** -The Availability Zone in which the Reserved Instance can be used.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -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 duration of the Reserved Instance, in seconds.
- */ -@property (nonatomic, strong) NSNumber *duration; - -/** -The purchase price of the Reserved Instance.
- */ -@property (nonatomic, strong) NSNumber *fixedPrice; - -/** -The tenancy of the reserved instance.
- */ -@property (nonatomic, assign) AWSEC2Tenancy instanceTenancy; - -/** -The instance type on which the Reserved Instance can be used.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** -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 Reserved Instance offering type.
- */ -@property (nonatomic, assign) AWSEC2OfferingTypeValues offeringType; - -/** -The pricing details of the Reserved Instance offering.
- */ -@property (nonatomic, strong) NSArray *pricingDetails; - -/** -The Reserved Instance description.
- */ -@property (nonatomic, assign) AWSEC2RIProductDescription productDescription; - -/** -The recurring charge tag assigned to the resource.
- */ -@property (nonatomic, strong) NSArray *recurringCharges; - -/** -The ID of the Reserved Instance offering.
- */ -@property (nonatomic, strong) NSString *reservedInstancesOfferingId; - -/** -The usage price of the Reserved Instance, per hour.
- */ -@property (nonatomic, strong) NSNumber *usagePrice; - -@end - -/** - - */ -@interface AWSEC2ResetImageAttributeRequest : AWSRequest - - -/** -The attribute to reset (currently you can only reset the launch permission attribute).
- */ -@property (nonatomic, assign) AWSEC2ResetImageAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the AMI.
- */ -@property (nonatomic, strong) NSString *imageId; - -@end - -/** - - */ -@interface AWSEC2ResetInstanceAttributeRequest : AWSRequest - - -/** -The attribute to reset.
- */ -@property (nonatomic, assign) AWSEC2InstanceAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -@end - -/** - - */ -@interface AWSEC2ResetNetworkInterfaceAttributeRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -The source/destination checking attribute. Resets the value to true.
The attribute to reset (currently only the attribute for permission to create volumes can be reset).
- */ -@property (nonatomic, assign) AWSEC2SnapshotAttributeName attribute; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -The ID of the snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -@end - -/** - - */ -@interface AWSEC2RevokeSecurityGroupEgressRequest : AWSRequest - - -/** -The CIDR IP address range. You can't specify this parameter when specifying a source security group.
- */ -@property (nonatomic, strong) NSString *cidrIp; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSArray *ipPermissions; - -/** -The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
[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.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupName; - -/** -The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupOwnerId; - -/** -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.
- */ -@property (nonatomic, strong) NSString *cidrIp; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -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 ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -[EC2-Classic, default VPC] The name of the security group.
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSArray *ipPermissions; - -/** -The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
[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.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupName; - -/** -The ID of the source security group. You can't specify a source security group and a CIDR IP address range.
- */ -@property (nonatomic, strong) NSString *sourceSecurityGroupOwnerId; - -/** -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.
Describes a route in a route table.
- */ -@interface AWSEC2Route : AWSModel - - -/** -The CIDR block used for the destination match.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** -The ID of a gateway attached to your VPC.
- */ -@property (nonatomic, strong) NSString *gatewayId; - -/** -The ID of a NAT instance in your VPC.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The AWS account ID of the owner of the instance.
- */ -@property (nonatomic, strong) NSString *instanceOwnerId; - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -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.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).
The ID of the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** -Describes a route table.
- */ -@interface AWSEC2RouteTable : AWSModel - - -/** -The associations between the route table and one or more subnets.
- */ -@property (nonatomic, strong) NSArray *associations; - -/** -Any virtual private gateway (VGW) propagating routes.
- */ -@property (nonatomic, strong) NSArray *propagatingVgws; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -/** -The routes in the route table.
- */ -@property (nonatomic, strong) NSArray *routes; - -/** -Any tags assigned to the route table.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes an association between a route table and a subnet.
- */ -@interface AWSEC2RouteTableAssociation : AWSModel - - -/** -Indicates whether this is the main route table.
- */ -@property (nonatomic, strong) NSNumber *main; - -/** -The ID of the association between a route table and a subnet.
- */ -@property (nonatomic, strong) NSString *routeTableAssociationId; - -/** -The ID of the route table.
- */ -@property (nonatomic, strong) NSString *routeTableId; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -@end - -/** -Describes the monitoring for the instance.
- Required parameters: [Enabled] - */ -@interface AWSEC2RunInstancesMonitoringEnabled : AWSModel - - -/** -Indicates whether monitoring is enabled for the instance.
- */ -@property (nonatomic, strong) NSNumber *enabled; - -@end - -/** - - */ -@interface AWSEC2RunInstancesRequest : AWSRequest - - -/** -Reserved.
- */ -@property (nonatomic, strong) NSString *additionalInfo; - -/** -The block device mapping.
- */ -@property (nonatomic, strong) NSArray *blockDeviceMappings; - -/** -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
- */ -@property (nonatomic, strong) NSString *clientToken; - -/** -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 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 IAM instance profile.
- */ -@property (nonatomic, strong) AWSEC2IamInstanceProfileSpecification *iamInstanceProfile; - -/** -The ID of the AMI, which you can get by calling DescribeImages.
- */ -@property (nonatomic, strong) NSString *imageId; - -/** -Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
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 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.
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.
- */ -@property (nonatomic, strong) NSNumber *maxCount; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *minCount; - -/** -The monitoring for the instance.
- */ -@property (nonatomic, strong) AWSEC2RunInstancesMonitoringEnabled *monitoring; - -/** -One or more network interfaces.
- */ -@property (nonatomic, strong) NSArray *networkInterfaces; - -/** -The placement for the instance.
- */ -@property (nonatomic, strong) AWSEC2Placement *placement; - -/** -[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.
- */ -@property (nonatomic, strong) NSString *privateIpAddress; - -/** -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.
One or more security group IDs. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
- */ -@property (nonatomic, strong) NSArray *securityGroupIds; - -/** -[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.
- */ -@property (nonatomic, strong) NSArray *securityGroups; - -/** -[EC2-VPC] The ID of the subnet to launch the instance into.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -The Base64-encoded MIME user data for the instances.
- */ -@property (nonatomic, strong) NSString *userData; - -@end - -/** -Describes the S3 bucket for an instance store-backed AMI.
- */ -@interface AWSEC2S3Storage : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *AWSAccessKeyId; - -/** -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.
- */ -@property (nonatomic, strong) NSString *bucket; - -/** -The beginning of the file name of the AMI.
- */ -@property (nonatomic, strong) NSString *prefix; - -/** -A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
- */ -@property (nonatomic, strong) NSData *uploadPolicy; - -/** -The signature of the Base64 encoded JSON document.
- */ -@property (nonatomic, strong) NSString *uploadPolicySignature; - -@end - -/** -Describes a security group
- */ -@interface AWSEC2SecurityGroup : AWSModel - - -/** -A description of the security group.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The ID of the security group.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -The name of the security group.
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -One or more inbound rules associated with the security group.
- */ -@property (nonatomic, strong) NSArray *ipPermissions; - -/** -[EC2-VPC] One or more outbound rules associated with the security group.
- */ -@property (nonatomic, strong) NSArray *ipPermissionsEgress; - -/** -The AWS account ID of the owner of the security group.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -Any tags assigned to the security group.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -[EC2-VPC] The ID of the VPC for the security group.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes a snapshot.
- */ -@interface AWSEC2Snapshot : AWSModel - - -/** -The description for the snapshot.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -Indicates whether the snapshot is encrypted.
- */ -@property (nonatomic, strong) NSNumber *encrypted; - -/** -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.
- */ -@property (nonatomic, strong) NSString *kmsKeyId; - -/** -The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
The AWS account ID of the Amazon EBS snapshot owner.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The progress of the snapshot, as a percentage.
- */ -@property (nonatomic, strong) NSString *progress; - -/** -The ID of the snapshot.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -/** -The time stamp when the snapshot was initiated.
- */ -@property (nonatomic, strong) NSDate *startTime; - -/** -The snapshot state.
- */ -@property (nonatomic, assign) AWSEC2SnapshotState state; - -/** -Any tags assigned to the snapshot.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -/** -The size of the volume, in GiB.
- */ -@property (nonatomic, strong) NSNumber *volumeSize; - -@end - -/** -Describes the datafeed for a Spot Instance.
- */ -@interface AWSEC2SpotDatafeedSubscription : AWSModel - - -/** -The Amazon S3 bucket where the Spot Instance datafeed is located.
- */ -@property (nonatomic, strong) NSString *bucket; - -/** -The fault codes for the Spot Instance request, if any.
- */ -@property (nonatomic, strong) AWSEC2SpotInstanceStateFault *fault; - -/** -The AWS account ID of the account.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The prefix that is prepended to datafeed files.
- */ -@property (nonatomic, strong) NSString *prefix; - -/** -The state of the Spot Instance datafeed subscription.
- */ -@property (nonatomic, assign) AWSEC2DatafeedSubscriptionState state; - -@end - -/** -Describe a Spot Instance request.
- */ -@interface AWSEC2SpotInstanceRequest : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *availabilityZoneGroup; - -/** -The time stamp when the Spot Instance request was created.
- */ -@property (nonatomic, strong) NSDate *createTime; - -/** -The fault codes for the Spot Instance request, if any.
- */ -@property (nonatomic, strong) AWSEC2SpotInstanceStateFault *fault; - -/** -The instance ID, if an instance has been launched to fulfill the Spot Instance request.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
- */ -@property (nonatomic, strong) NSString *launchGroup; - -/** -Additional information for launching instances.
- */ -@property (nonatomic, strong) AWSEC2LaunchSpecification *launchSpecification; - -/** -The Availability Zone in which the bid is launched.
- */ -@property (nonatomic, strong) NSString *launchedAvailabilityZone; - -/** -The product description associated with the Spot Instance.
- */ -@property (nonatomic, assign) AWSEC2RIProductDescription productDescription; - -/** -The ID of the Spot Instance request.
- */ -@property (nonatomic, strong) NSString *spotInstanceRequestId; - -/** -The maximum hourly price for any Spot Instance launched to fulfill the request.
- */ -@property (nonatomic, strong) NSString *spotPrice; - -/** -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.
- */ -@property (nonatomic, assign) AWSEC2SpotInstanceState state; - -/** -The status code and status message describing the Spot Instance request.
- */ -@property (nonatomic, strong) AWSEC2SpotInstanceStatus *status; - -/** -Any tags assigned to the resource.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The Spot Instance request type.
- */ -@property (nonatomic, assign) AWSEC2SpotInstanceType types; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *validFrom; - -/** -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.
- */ -@property (nonatomic, strong) NSDate *validUntil; - -@end - -/** -Describes a Spot Instance state change.
- */ -@interface AWSEC2SpotInstanceStateFault : AWSModel - - -/** -The reason code for the Spot Instance state change.
- */ -@property (nonatomic, strong) NSString *code; - -/** -The message for the Spot Instance state change.
- */ -@property (nonatomic, strong) NSString *message; - -@end - -/** -Describes a Spot Instance request.
- */ -@interface AWSEC2SpotInstanceStatus : AWSModel - - -/** -The status code of the request.
- */ -@property (nonatomic, strong) NSString *code; - -/** -The description for the status code for the Spot request.
- */ -@property (nonatomic, strong) NSString *message; - -/** -The time of the most recent status update.
- */ -@property (nonatomic, strong) NSDate *updateTime; - -@end - -/** -Describes Spot Instance placement.
- */ -@interface AWSEC2SpotPlacement : AWSModel - - -/** -The Availability Zone.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The name of the placement group (for cluster instances).
- */ -@property (nonatomic, strong) NSString *groupName; - -@end - -/** -Describes the Spot Price.
- */ -@interface AWSEC2SpotPrice : AWSModel - - -/** -The Availability Zone.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The instance type.
- */ -@property (nonatomic, assign) AWSEC2InstanceType instanceType; - -/** -A general description of the AMI.
- */ -@property (nonatomic, assign) AWSEC2RIProductDescription productDescription; - -/** -The maximum price you will pay to launch one or more Spot Instances.
- */ -@property (nonatomic, strong) NSString *spotPrice; - -/** -The date and time the request was created.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -@end - -/** - - */ -@interface AWSEC2StartInstancesRequest : AWSRequest - - -/** -Reserved.
- */ -@property (nonatomic, strong) NSString *additionalInfo; - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** - - */ -@interface AWSEC2StartInstancesResult : AWSModel - - -/** -Information about one or more started instances.
- */ -@property (nonatomic, strong) NSArray *startingInstances; - -@end - -/** -Describes a state change.
- */ -@interface AWSEC2StateReason : AWSModel - - -/** -The reason code for the state change.
- */ -@property (nonatomic, strong) NSString *code; - -/** -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.
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
One or more instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** - - */ -@interface AWSEC2StopInstancesResult : AWSModel - - -/** -Information about one or more stopped instances.
- */ -@property (nonatomic, strong) NSArray *stoppingInstances; - -@end - -/** -Describes the storage location for an instance store-backed AMI.
- */ -@interface AWSEC2Storage : AWSModel - - -/** -An Amazon S3 storage location.
- */ -@property (nonatomic, strong) AWSEC2S3Storage *s3; - -@end - -/** -Describes a subnet.
- */ -@interface AWSEC2Subnet : AWSModel - - -/** -The Availability Zone of the subnet.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.
- */ -@property (nonatomic, strong) NSNumber *availableIpAddressCount; - -/** -The CIDR block assigned to the subnet.
- */ -@property (nonatomic, strong) NSString *cidrBlock; - -/** -Indicates whether this is the default subnet for the Availability Zone.
- */ -@property (nonatomic, strong) NSNumber *defaultForAz; - -/** -Indicates whether instances launched in this subnet receive a public IP address.
- */ -@property (nonatomic, strong) NSNumber *mapPublicIpOnLaunch; - -/** -The current state of the subnet.
- */ -@property (nonatomic, assign) AWSEC2SubnetState state; - -/** -The ID of the subnet.
- */ -@property (nonatomic, strong) NSString *subnetId; - -/** -Any tags assigned to the subnet.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the VPC the subnet is in.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes a tag.
- */ -@interface AWSEC2Tag : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *value; - -@end - -/** -Describes a tag.
- */ -@interface AWSEC2TagDescription : AWSModel - - -/** -The key of the tag.
- */ -@property (nonatomic, strong) NSString *key; - -/** -The ID of the resource. For example, ami-1a2b3c4d.
The type of resource.
- */ -@property (nonatomic, assign) AWSEC2ResourceType resourceType; - -/** -The value of the tag.
- */ -@property (nonatomic, strong) NSString *value; - -@end - -/** - - */ -@interface AWSEC2TerminateInstancesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** - - */ -@interface AWSEC2TerminateInstancesResult : AWSModel - - -/** -Information about one or more terminated instances.
- */ -@property (nonatomic, strong) NSArray *terminatingInstances; - -@end - -/** - - */ -@interface AWSEC2UnassignPrivateIpAddressesRequest : AWSRequest - - -/** -The ID of the network interface.
- */ -@property (nonatomic, strong) NSString *networkInterfaceId; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *privateIpAddresses; - -@end - -/** - - */ -@interface AWSEC2UnmonitorInstancesRequest : AWSRequest - - -/** - - */ -@property (nonatomic, strong) NSNumber *dryRun; - -/** -One or more instance IDs.
- */ -@property (nonatomic, strong) NSArray *instanceIds; - -@end - -/** - - */ -@interface AWSEC2UnmonitorInstancesResult : AWSModel - - -/** -Monitoring information for one or more instances.
- */ -@property (nonatomic, strong) NSArray *instanceMonitorings; - -@end - -/** -Describes a security group and AWS account ID pair for EC2-Classic.
- */ -@interface AWSEC2UserIdGroupPair : AWSModel - - -/** -The name of the security group in the specified AWS account.
- */ -@property (nonatomic, strong) NSString *groupId; - -/** -The ID of the security group owned by the specified AWS account.
- */ -@property (nonatomic, strong) NSString *groupName; - -/** -The ID of an AWS account.
- */ -@property (nonatomic, strong) NSString *userId; - -@end - -/** -Describes telemetry for a VPN tunnel.
- */ -@interface AWSEC2VgwTelemetry : AWSModel - - -/** -The number of accepted routes.
- */ -@property (nonatomic, strong) NSNumber *acceptedRouteCount; - -/** -The date and time of the last change in status.
- */ -@property (nonatomic, strong) NSDate *lastStatusChange; - -/** -The Internet-routable IP address of the virtual private gateway's outside interface.
- */ -@property (nonatomic, strong) NSString *outsideIpAddress; - -/** -The status of the VPN tunnel.
- */ -@property (nonatomic, assign) AWSEC2TelemetryStatus status; - -/** -If an error occurs, a description of the error.
- */ -@property (nonatomic, strong) NSString *statusMessage; - -@end - -/** -Describes a volume.
- */ -@interface AWSEC2Volume : AWSModel - - -/** - - */ -@property (nonatomic, strong) NSArray *attachments; - -/** -The Availability Zone for the volume.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The time stamp when volume creation was initiated.
- */ -@property (nonatomic, strong) NSDate *createTime; - -/** -Indicates whether the volume is encrypted.
- */ -@property (nonatomic, strong) NSNumber *encrypted; - -/** -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.
The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.
- */ -@property (nonatomic, strong) NSString *kmsKeyId; - -/** -The size of the volume, in GiBs.
- */ -@property (nonatomic, strong) NSNumber *size; - -/** -The snapshot from which the volume was created, if applicable.
- */ -@property (nonatomic, strong) NSString *snapshotId; - -/** -The volume state.
- */ -@property (nonatomic, assign) AWSEC2VolumeState state; - -/** -Any tags assigned to the volume.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -/** -The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
Describes volume attachment details.
- */ -@interface AWSEC2VolumeAttachment : AWSModel - - -/** -The time stamp when the attachment initiated.
- */ -@property (nonatomic, strong) NSDate *attachTime; - -/** -Indicates whether the Amazon EBS volume is deleted on instance termination.
- */ -@property (nonatomic, strong) NSNumber *deleteOnTermination; - -/** -The device name.
- */ -@property (nonatomic, strong) NSString *device; - -/** -The ID of the instance.
- */ -@property (nonatomic, strong) NSString *instanceId; - -/** -The attachment state of the volume.
- */ -@property (nonatomic, assign) AWSEC2VolumeAttachmentState state; - -/** -The ID of the volume.
- */ -@property (nonatomic, strong) NSString *volumeId; - -@end - -/** -Describes an Amazon EBS volume.
- Required parameters: [Size] - */ -@interface AWSEC2VolumeDetail : AWSModel - - -/** -The size of the volume, in GiB.
- */ -@property (nonatomic, strong) NSNumber *size; - -@end - -/** -Describes a volume status operation code.
- */ -@interface AWSEC2VolumeStatusAction : AWSModel - - -/** -The code identifying the operation, for example, enable-volume-io.
A description of the operation.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The ID of the event associated with this operation.
- */ -@property (nonatomic, strong) NSString *eventId; - -/** -The event type associated with this operation.
- */ -@property (nonatomic, strong) NSString *eventType; - -@end - -/** -Describes a volume status.
- */ -@interface AWSEC2VolumeStatusDetails : AWSModel - - -/** -The name of the volume status.
- */ -@property (nonatomic, assign) AWSEC2VolumeStatusName name; - -/** -The intended status of the volume status.
- */ -@property (nonatomic, strong) NSString *status; - -@end - -/** -Describes a volume status event.
- */ -@interface AWSEC2VolumeStatusEvent : AWSModel - - -/** -A description of the event.
- */ -@property (nonatomic, strong) NSString *detail; - -/** -The ID of this event.
- */ -@property (nonatomic, strong) NSString *eventId; - -/** -The type of this event.
- */ -@property (nonatomic, strong) NSString *eventType; - -/** -The latest end time of the event.
- */ -@property (nonatomic, strong) NSDate *notAfter; - -/** -The earliest start time of the event.
- */ -@property (nonatomic, strong) NSDate *notBefore; - -@end - -/** -Describes the status of a volume.
- */ -@interface AWSEC2VolumeStatusInfo : AWSModel - - -/** -The details of the volume status.
- */ -@property (nonatomic, strong) NSArray *details; - -/** -The status of the volume.
- */ -@property (nonatomic, assign) AWSEC2VolumeStatusInfoStatus status; - -@end - -/** -Describes the volume status.
- */ -@interface AWSEC2VolumeStatusItem : AWSModel - - -/** -The details of the operation.
- */ -@property (nonatomic, strong) NSArray *actions; - -/** -The Availability Zone of the volume.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -A list of events associated with the volume.
- */ -@property (nonatomic, strong) NSArray *events; - -/** -The volume ID.
- */ -@property (nonatomic, strong) NSString *volumeId; - -/** -The volume status.
- */ -@property (nonatomic, strong) AWSEC2VolumeStatusInfo *volumeStatus; - -@end - -/** -Describes a VPC.
- */ -@interface AWSEC2Vpc : AWSModel - - -/** -The CIDR block for the VPC.
- */ -@property (nonatomic, strong) NSString *cidrBlock; - -/** -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).
The allowed tenancy of instances launched into the VPC.
- */ -@property (nonatomic, assign) AWSEC2Tenancy instanceTenancy; - -/** -Indicates whether the VPC is the default VPC.
- */ -@property (nonatomic, strong) NSNumber *isDefault; - -/** -The current state of the VPC.
- */ -@property (nonatomic, assign) AWSEC2VpcState state; - -/** -Any tags assigned to the VPC.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes an attachment between a virtual private gateway and a VPC.
- */ -@interface AWSEC2VpcAttachment : AWSModel - - -/** -The current state of the attachment.
- */ -@property (nonatomic, assign) AWSEC2AttachmentStatus state; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes a VPC peering connection.
- */ -@interface AWSEC2VpcPeeringConnection : AWSModel - - -/** -The information of the peer VPC.
- */ -@property (nonatomic, strong) AWSEC2VpcPeeringConnectionVpcInfo *accepterVpcInfo; - -/** -The time that an unaccepted VPC peering connection will expire.
- */ -@property (nonatomic, strong) NSDate *expirationTime; - -/** -The information of the requester VPC.
- */ -@property (nonatomic, strong) AWSEC2VpcPeeringConnectionVpcInfo *requesterVpcInfo; - -/** -The status of the VPC peering connection.
- */ -@property (nonatomic, strong) AWSEC2VpcPeeringConnectionStateReason *status; - -/** -Any tags assigned to the resource.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The ID of the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *vpcPeeringConnectionId; - -@end - -/** -Describes the status of a VPC peering connection.
- */ -@interface AWSEC2VpcPeeringConnectionStateReason : AWSModel - - -/** -The status of the VPC peering connection.
- */ -@property (nonatomic, strong) NSString *code; - -/** -A message that provides more information about the status, if applicable.
- */ -@property (nonatomic, strong) NSString *message; - -@end - -/** -Describes a VPC in a VPC peering connection.
- */ -@interface AWSEC2VpcPeeringConnectionVpcInfo : AWSModel - - -/** -The CIDR block for the VPC.
- */ -@property (nonatomic, strong) NSString *cidrBlock; - -/** -The AWS account ID of the VPC owner.
- */ -@property (nonatomic, strong) NSString *ownerId; - -/** -The ID of the VPC.
- */ -@property (nonatomic, strong) NSString *vpcId; - -@end - -/** -Describes a VPN connection.
- */ -@interface AWSEC2VpnConnection : AWSModel - - -/** -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 ID of the customer gateway at your end of the VPN connection.
- */ -@property (nonatomic, strong) NSString *customerGatewayId; - -/** -The VPN connection options.
- */ -@property (nonatomic, strong) AWSEC2VpnConnectionOptions *options; - -/** -The static routes associated with the VPN connection.
- */ -@property (nonatomic, strong) NSArray *routes; - -/** -The current state of the VPN connection.
- */ -@property (nonatomic, assign) AWSEC2VpnState state; - -/** -Any tags assigned to the VPN connection.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The type of VPN connection.
- */ -@property (nonatomic, assign) AWSEC2GatewayType types; - -/** -Information about the VPN tunnel.
- */ -@property (nonatomic, strong) NSArray *vgwTelemetry; - -/** -The ID of the VPN connection.
- */ -@property (nonatomic, strong) NSString *vpnConnectionId; - -/** -The ID of the virtual private gateway at the AWS side of the VPN connection.
- */ -@property (nonatomic, strong) NSString *vpnGatewayId; - -@end - -/** -Describes VPN connection options.
- */ -@interface AWSEC2VpnConnectionOptions : AWSModel - - -/** -Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
- */ -@property (nonatomic, strong) NSNumber *staticRoutesOnly; - -@end - -/** -Describes VPN connection options.
- */ -@interface AWSEC2VpnConnectionOptionsSpecification : AWSModel - - -/** -Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
- */ -@property (nonatomic, strong) NSNumber *staticRoutesOnly; - -@end - -/** -Describes a virtual private gateway.
- */ -@interface AWSEC2VpnGateway : AWSModel - - -/** -The Availability Zone where the virtual private gateway was created.
- */ -@property (nonatomic, strong) NSString *availabilityZone; - -/** -The current state of the virtual private gateway.
- */ -@property (nonatomic, assign) AWSEC2VpnState state; - -/** -Any tags assigned to the virtual private gateway.
- */ -@property (nonatomic, strong) NSArray *tags; - -/** -The type of VPN connection the virtual private gateway supports.
- */ -@property (nonatomic, assign) AWSEC2GatewayType types; - -/** -Any VPCs attached to the virtual private gateway.
- */ -@property (nonatomic, strong) NSArray *vpcAttachments; - -/** -The ID of the virtual private gateway.
- */ -@property (nonatomic, strong) NSString *vpnGatewayId; - -@end - -/** -Describes a static route for a VPN connection.
- */ -@interface AWSEC2VpnStaticRoute : AWSModel - - -/** -The CIDR block associated with the local subnet of the customer data center.
- */ -@property (nonatomic, strong) NSString *destinationCidrBlock; - -/** -Indicates how the routes were provided.
- */ -@property (nonatomic, assign) AWSEC2VpnStaticRouteSource source; - -/** -The current state of the static route.
- */ -@property (nonatomic, assign) AWSEC2VpnState state; - -@end diff --git a/Frameworks/AWSEC2.framework/Headers/AWSEC2Service.h b/Frameworks/AWSEC2.framework/Headers/AWSEC2Service.h deleted file mode 100644 index 4b419ca..0000000 --- a/Frameworks/AWSEC2.framework/Headers/AWSEC2Service.h +++ /dev/null @@ -1,1973 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importAmazon 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.
- */ -@interface AWSEC2 : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let EC2 = AWSEC2.defaultEC2() - - *Objective-C* - - AWSEC2 *EC2 = [AWSEC2 defaultEC2]; - - @return The default service client. - */ -+ (instancetype)defaultEC2; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSEC2.registerEC2WithConfiguration(configuration, forKey: "USWest2EC2") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSEC2 registerEC2WithConfiguration:configuration forKey:@"USWest2EC2"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let EC2 = AWSEC2(forKey: "USWest2EC2") - - *Objective-C* - - AWSEC2 *EC2 = [AWSEC2 EC2ForKey:@"USWest2EC2"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerEC2WithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerEC2WithConfiguration:forKey:` before invoking this method. If `+ registerEC2WithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSEC2.registerEC2WithConfiguration(configuration, forKey: "USWest2EC2") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSEC2 registerEC2WithConfiguration:configuration forKey:@"USWest2EC2"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let EC2 = AWSEC2(forKey: "USWest2EC2") - - *Objective-C* - - AWSEC2 *EC2 = [AWSEC2 EC2ForKey:@"USWest2EC2"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)EC2ForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeEC2ForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerEC2WithConfiguration:forKey:` and `+ EC2ForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerEC2WithConfiguration:forKey:' and '+ EC2ForKey:' instead."))); - -/** -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.
- - @param request A container for the necessary parameters to execute the AllocateAddress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2AllocateAddressResult`. - - @see AWSEC2AllocateAddressRequest - @see AWSEC2AllocateAddressResult - */ -- (BFTask *)allocateAddress:(AWSEC2AllocateAddressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AssignPrivateIpAddresses service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2AssignPrivateIpAddressesRequest - */ -- (BFTask *)assignPrivateIpAddresses:(AWSEC2AssignPrivateIpAddressesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AssociateAddress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2AssociateAddressResult`. - - @see AWSEC2AssociateAddressRequest - @see AWSEC2AssociateAddressResult - */ -- (BFTask *)associateAddress:(AWSEC2AssociateAddressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AssociateDhcpOptions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2AssociateDhcpOptionsRequest - */ -- (BFTask *)associateDhcpOptions:(AWSEC2AssociateDhcpOptionsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AssociateRouteTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2AssociateRouteTableResult`. - - @see AWSEC2AssociateRouteTableRequest - @see AWSEC2AssociateRouteTableResult - */ -- (BFTask *)associateRouteTable:(AWSEC2AssociateRouteTableRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AttachInternetGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2AttachInternetGatewayRequest - */ -- (BFTask *)attachInternetGateway:(AWSEC2AttachInternetGatewayRequest *)request; - -/** -Attaches a network interface to an instance.
- - @param request A container for the necessary parameters to execute the AttachNetworkInterface service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2AttachNetworkInterfaceResult`. - - @see AWSEC2AttachNetworkInterfaceRequest - @see AWSEC2AttachNetworkInterfaceResult - */ -- (BFTask *)attachNetworkInterface:(AWSEC2AttachNetworkInterfaceRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AttachVolume service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2VolumeAttachment`. - - @see AWSEC2AttachVolumeRequest - @see AWSEC2VolumeAttachment - */ -- (BFTask *)attachVolume:(AWSEC2AttachVolumeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AttachVpnGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2AttachVpnGatewayResult`. - - @see AWSEC2AttachVpnGatewayRequest - @see AWSEC2AttachVpnGatewayResult - */ -- (BFTask *)attachVpnGateway:(AWSEC2AttachVpnGatewayRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2AuthorizeSecurityGroupEgressRequest - */ -- (BFTask *)authorizeSecurityGroupEgress:(AWSEC2AuthorizeSecurityGroupEgressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2AuthorizeSecurityGroupIngressRequest - */ -- (BFTask *)authorizeSecurityGroupIngress:(AWSEC2AuthorizeSecurityGroupIngressRequest *)request; - -/** -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 procedure 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.
- - @param request A container for the necessary parameters to execute the BundleInstance service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2BundleInstanceResult`. - - @see AWSEC2BundleInstanceRequest - @see AWSEC2BundleInstanceResult - */ -- (BFTask *)bundleInstance:(AWSEC2BundleInstanceRequest *)request; - -/** -Cancels a bundling operation for an instance store-backed Windows instance.
- - @param request A container for the necessary parameters to execute the CancelBundleTask service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CancelBundleTaskResult`. - - @see AWSEC2CancelBundleTaskRequest - @see AWSEC2CancelBundleTaskResult - */ -- (BFTask *)cancelBundleTask:(AWSEC2CancelBundleTaskRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CancelConversionTask service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CancelConversionRequest - */ -- (BFTask *)cancelConversionTask:(AWSEC2CancelConversionRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CancelExportTask service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CancelExportTaskRequest - */ -- (BFTask *)cancelExportTask:(AWSEC2CancelExportTaskRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CancelReservedInstancesListing service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CancelReservedInstancesListingResult`. - - @see AWSEC2CancelReservedInstancesListingRequest - @see AWSEC2CancelReservedInstancesListingResult - */ -- (BFTask *)cancelReservedInstancesListing:(AWSEC2CancelReservedInstancesListingRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ConfirmProductInstance service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ConfirmProductInstanceResult`. - - @see AWSEC2ConfirmProductInstanceRequest - @see AWSEC2ConfirmProductInstanceResult - */ -- (BFTask *)confirmProductInstance:(AWSEC2ConfirmProductInstanceRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateCustomerGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateCustomerGatewayResult`. - - @see AWSEC2CreateCustomerGatewayRequest - @see AWSEC2CreateCustomerGatewayResult - */ -- (BFTask *)createCustomerGateway:(AWSEC2CreateCustomerGatewayRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateImage service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateImageResult`. - - @see AWSEC2CreateImageRequest - @see AWSEC2CreateImageResult - */ -- (BFTask *)createImage:(AWSEC2CreateImageRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateInstanceExportTask service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateInstanceExportTaskResult`. - - @see AWSEC2CreateInstanceExportTaskRequest - @see AWSEC2CreateInstanceExportTaskResult - */ -- (BFTask *)createInstanceExportTask:(AWSEC2CreateInstanceExportTaskRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateInternetGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateInternetGatewayResult`. - - @see AWSEC2CreateInternetGatewayRequest - @see AWSEC2CreateInternetGatewayResult - */ -- (BFTask *)createInternetGateway:(AWSEC2CreateInternetGatewayRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateKeyPair service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2KeyPair`. - - @see AWSEC2CreateKeyPairRequest - @see AWSEC2KeyPair - */ -- (BFTask *)createKeyPair:(AWSEC2CreateKeyPairRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateNetworkAcl service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateNetworkAclResult`. - - @see AWSEC2CreateNetworkAclRequest - @see AWSEC2CreateNetworkAclResult - */ -- (BFTask *)createNetworkAcl:(AWSEC2CreateNetworkAclRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateNetworkAclEntry service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CreateNetworkAclEntryRequest - */ -- (BFTask *)createNetworkAclEntry:(AWSEC2CreateNetworkAclEntryRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateNetworkInterface service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateNetworkInterfaceResult`. - - @see AWSEC2CreateNetworkInterfaceRequest - @see AWSEC2CreateNetworkInterfaceResult - */ -- (BFTask *)createNetworkInterface:(AWSEC2CreateNetworkInterfaceRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreatePlacementGroup service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CreatePlacementGroupRequest - */ -- (BFTask *)createPlacementGroup:(AWSEC2CreatePlacementGroupRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateReservedInstancesListing service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateReservedInstancesListingResult`. - - @see AWSEC2CreateReservedInstancesListingRequest - @see AWSEC2CreateReservedInstancesListingResult - */ -- (BFTask *)createReservedInstancesListing:(AWSEC2CreateReservedInstancesListingRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateRoute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CreateRouteRequest - */ -- (BFTask *)createRoute:(AWSEC2CreateRouteRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateRouteTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateRouteTableResult`. - - @see AWSEC2CreateRouteTableRequest - @see AWSEC2CreateRouteTableResult - */ -- (BFTask *)createRouteTable:(AWSEC2CreateRouteTableRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateSecurityGroup service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateSecurityGroupResult`. - - @see AWSEC2CreateSecurityGroupRequest - @see AWSEC2CreateSecurityGroupResult - */ -- (BFTask *)createSecurityGroup:(AWSEC2CreateSecurityGroupRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateSnapshot service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2Snapshot`. - - @see AWSEC2CreateSnapshotRequest - @see AWSEC2Snapshot - */ -- (BFTask *)createSnapshot:(AWSEC2CreateSnapshotRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateSpotDatafeedSubscriptionResult`. - - @see AWSEC2CreateSpotDatafeedSubscriptionRequest - @see AWSEC2CreateSpotDatafeedSubscriptionResult - */ -- (BFTask *)createSpotDatafeedSubscription:(AWSEC2CreateSpotDatafeedSubscriptionRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateSubnet service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateSubnetResult`. - - @see AWSEC2CreateSubnetRequest - @see AWSEC2CreateSubnetResult - */ -- (BFTask *)createSubnet:(AWSEC2CreateSubnetRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateTags service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CreateTagsRequest - */ -- (BFTask *)createTags:(AWSEC2CreateTagsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateVolume service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2Volume`. - - @see AWSEC2CreateVolumeRequest - @see AWSEC2Volume - */ -- (BFTask *)createVolume:(AWSEC2CreateVolumeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateVpc service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateVpcResult`. - - @see AWSEC2CreateVpcRequest - @see AWSEC2CreateVpcResult - */ -- (BFTask *)createVpc:(AWSEC2CreateVpcRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateVpnConnection service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateVpnConnectionResult`. - - @see AWSEC2CreateVpnConnectionRequest - @see AWSEC2CreateVpnConnectionResult - */ -- (BFTask *)createVpnConnection:(AWSEC2CreateVpnConnectionRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateVpnConnectionRoute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2CreateVpnConnectionRouteRequest - */ -- (BFTask *)createVpnConnectionRoute:(AWSEC2CreateVpnConnectionRouteRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateVpnGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2CreateVpnGatewayResult`. - - @see AWSEC2CreateVpnGatewayRequest - @see AWSEC2CreateVpnGatewayResult - */ -- (BFTask *)createVpnGateway:(AWSEC2CreateVpnGatewayRequest *)request; - -/** -Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
- - @param request A container for the necessary parameters to execute the DeleteCustomerGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteCustomerGatewayRequest - */ -- (BFTask *)deleteCustomerGateway:(AWSEC2DeleteCustomerGatewayRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteDhcpOptions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteDhcpOptionsRequest - */ -- (BFTask *)deleteDhcpOptions:(AWSEC2DeleteDhcpOptionsRequest *)request; - -/** -Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.
- - @param request A container for the necessary parameters to execute the DeleteInternetGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteInternetGatewayRequest - */ -- (BFTask *)deleteInternetGateway:(AWSEC2DeleteInternetGatewayRequest *)request; - -/** -Deletes the specified key pair, by removing the public key from Amazon EC2.
- - @param request A container for the necessary parameters to execute the DeleteKeyPair service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteKeyPairRequest - */ -- (BFTask *)deleteKeyPair:(AWSEC2DeleteKeyPairRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteNetworkAcl service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteNetworkAclRequest - */ -- (BFTask *)deleteNetworkAcl:(AWSEC2DeleteNetworkAclRequest *)request; - -/** -Deletes the specified ingress or egress entry (rule) from the specified network ACL.
- - @param request A container for the necessary parameters to execute the DeleteNetworkAclEntry service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteNetworkAclEntryRequest - */ -- (BFTask *)deleteNetworkAclEntry:(AWSEC2DeleteNetworkAclEntryRequest *)request; - -/** -Deletes the specified network interface. You must detach the network interface before you can delete it.
- - @param request A container for the necessary parameters to execute the DeleteNetworkInterface service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteNetworkInterfaceRequest - */ -- (BFTask *)deleteNetworkInterface:(AWSEC2DeleteNetworkInterfaceRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeletePlacementGroup service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeletePlacementGroupRequest - */ -- (BFTask *)deletePlacementGroup:(AWSEC2DeletePlacementGroupRequest *)request; - -/** -Deletes the specified route from the specified route table.
- - @param request A container for the necessary parameters to execute the DeleteRoute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteRouteRequest - */ -- (BFTask *)deleteRoute:(AWSEC2DeleteRouteRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteRouteTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteRouteTableRequest - */ -- (BFTask *)deleteRouteTable:(AWSEC2DeleteRouteTableRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteSnapshot service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteSnapshotRequest - */ -- (BFTask *)deleteSnapshot:(AWSEC2DeleteSnapshotRequest *)request; - -/** -Deletes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
- - @param request A container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteSpotDatafeedSubscriptionRequest - */ -- (BFTask *)deleteSpotDatafeedSubscription:(AWSEC2DeleteSpotDatafeedSubscriptionRequest *)request; - -/** -Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
- - @param request A container for the necessary parameters to execute the DeleteSubnet service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteSubnetRequest - */ -- (BFTask *)deleteSubnet:(AWSEC2DeleteSubnetRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteTags service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteTagsRequest - */ -- (BFTask *)deleteTags:(AWSEC2DeleteTagsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteVolume service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteVolumeRequest - */ -- (BFTask *)deleteVolume:(AWSEC2DeleteVolumeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteVpc service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteVpcRequest - */ -- (BFTask *)deleteVpc:(AWSEC2DeleteVpcRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteVpnConnection service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteVpnConnectionRequest - */ -- (BFTask *)deleteVpnConnection:(AWSEC2DeleteVpnConnectionRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteVpnConnectionRoute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteVpnConnectionRouteRequest - */ -- (BFTask *)deleteVpnConnectionRoute:(AWSEC2DeleteVpnConnectionRouteRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteVpnGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeleteVpnGatewayRequest - */ -- (BFTask *)deleteVpnGateway:(AWSEC2DeleteVpnGatewayRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeregisterImage service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DeregisterImageRequest - */ -- (BFTask *)deregisterImage:(AWSEC2DeregisterImageRequest *)request; - -/** -Describes the specified attribute of your AWS account.
- - @param request A container for the necessary parameters to execute the DescribeAccountAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeAccountAttributesResult`. - - @see AWSEC2DescribeAccountAttributesRequest - @see AWSEC2DescribeAccountAttributesResult - */ -- (BFTask *)describeAccountAttributes:(AWSEC2DescribeAccountAttributesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeAddresses service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeAddressesResult`. - - @see AWSEC2DescribeAddressesRequest - @see AWSEC2DescribeAddressesResult - */ -- (BFTask *)describeAddresses:(AWSEC2DescribeAddressesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeAvailabilityZones service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeAvailabilityZonesResult`. - - @see AWSEC2DescribeAvailabilityZonesRequest - @see AWSEC2DescribeAvailabilityZonesResult - */ -- (BFTask *)describeAvailabilityZones:(AWSEC2DescribeAvailabilityZonesRequest *)request; - -/** -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 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.
- - @param request A container for the necessary parameters to execute the DescribeConversionTasks service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeConversionTasksResult`. - - @see AWSEC2DescribeConversionTasksRequest - @see AWSEC2DescribeConversionTasksResult - */ -- (BFTask *)describeConversionTasks:(AWSEC2DescribeConversionTasksRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeCustomerGateways service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeCustomerGatewaysResult`. - - @see AWSEC2DescribeCustomerGatewaysRequest - @see AWSEC2DescribeCustomerGatewaysResult - */ -- (BFTask *)describeCustomerGateways:(AWSEC2DescribeCustomerGatewaysRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeDhcpOptions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeDhcpOptionsResult`. - - @see AWSEC2DescribeDhcpOptionsRequest - @see AWSEC2DescribeDhcpOptionsResult - */ -- (BFTask *)describeDhcpOptions:(AWSEC2DescribeDhcpOptionsRequest *)request; - -/** -Describes one or more of your export tasks.
- - @param request A container for the necessary parameters to execute the DescribeExportTasks service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeExportTasksResult`. - - @see AWSEC2DescribeExportTasksRequest - @see AWSEC2DescribeExportTasksResult - */ -- (BFTask *)describeExportTasks:(AWSEC2DescribeExportTasksRequest *)request; - -/** -Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
- - @param request A container for the necessary parameters to execute the DescribeImageAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ImageAttribute`. - - @see AWSEC2DescribeImageAttributeRequest - @see AWSEC2ImageAttribute - */ -- (BFTask *)describeImageAttribute:(AWSEC2DescribeImageAttributeRequest *)request; - -/** -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 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.
- - @param request A container for the necessary parameters to execute the DescribeInstanceStatus service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeInstanceStatusResult`. - - @see AWSEC2DescribeInstanceStatusRequest - @see AWSEC2DescribeInstanceStatusResult - */ -- (BFTask *)describeInstanceStatus:(AWSEC2DescribeInstanceStatusRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeInstancesResult`. - - @see AWSEC2DescribeInstancesRequest - @see AWSEC2DescribeInstancesResult - */ -- (BFTask *)describeInstances:(AWSEC2DescribeInstancesRequest *)request; - -/** -Describes one or more of your Internet gateways.
- - @param request A container for the necessary parameters to execute the DescribeInternetGateways service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeInternetGatewaysResult`. - - @see AWSEC2DescribeInternetGatewaysRequest - @see AWSEC2DescribeInternetGatewaysResult - */ -- (BFTask *)describeInternetGateways:(AWSEC2DescribeInternetGatewaysRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeKeyPairs service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeKeyPairsResult`. - - @see AWSEC2DescribeKeyPairsRequest - @see AWSEC2DescribeKeyPairsResult - */ -- (BFTask *)describeKeyPairs:(AWSEC2DescribeKeyPairsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeNetworkAcls service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeNetworkAclsResult`. - - @see AWSEC2DescribeNetworkAclsRequest - @see AWSEC2DescribeNetworkAclsResult - */ -- (BFTask *)describeNetworkAcls:(AWSEC2DescribeNetworkAclsRequest *)request; - -/** -Describes a network interface attribute. You can specify only one attribute at a time.
- - @param request A container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeNetworkInterfaceAttributeResult`. - - @see AWSEC2DescribeNetworkInterfaceAttributeRequest - @see AWSEC2DescribeNetworkInterfaceAttributeResult - */ -- (BFTask *)describeNetworkInterfaceAttribute:(AWSEC2DescribeNetworkInterfaceAttributeRequest *)request; - -/** -Describes one or more of your network interfaces.
- - @param request A container for the necessary parameters to execute the DescribeNetworkInterfaces service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeNetworkInterfacesResult`. - - @see AWSEC2DescribeNetworkInterfacesRequest - @see AWSEC2DescribeNetworkInterfacesResult - */ -- (BFTask *)describeNetworkInterfaces:(AWSEC2DescribeNetworkInterfacesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribePlacementGroups service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribePlacementGroupsResult`. - - @see AWSEC2DescribePlacementGroupsRequest - @see AWSEC2DescribePlacementGroupsResult - */ -- (BFTask *)describePlacementGroups:(AWSEC2DescribePlacementGroupsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeRegions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeRegionsResult`. - - @see AWSEC2DescribeRegionsRequest - @see AWSEC2DescribeRegionsResult - */ -- (BFTask *)describeRegions:(AWSEC2DescribeRegionsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeReservedInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeReservedInstancesResult`. - - @see AWSEC2DescribeReservedInstancesRequest - @see AWSEC2DescribeReservedInstancesResult - */ -- (BFTask *)describeReservedInstances:(AWSEC2DescribeReservedInstancesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeReservedInstancesListings service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeReservedInstancesListingsResult`. - - @see AWSEC2DescribeReservedInstancesListingsRequest - @see AWSEC2DescribeReservedInstancesListingsResult - */ -- (BFTask *)describeReservedInstancesListings:(AWSEC2DescribeReservedInstancesListingsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeReservedInstancesModifications service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeReservedInstancesModificationsResult`. - - @see AWSEC2DescribeReservedInstancesModificationsRequest - @see AWSEC2DescribeReservedInstancesModificationsResult - */ -- (BFTask *)describeReservedInstancesModifications:(AWSEC2DescribeReservedInstancesModificationsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeReservedInstancesOfferingsResult`. - - @see AWSEC2DescribeReservedInstancesOfferingsRequest - @see AWSEC2DescribeReservedInstancesOfferingsResult - */ -- (BFTask *)describeReservedInstancesOfferings:(AWSEC2DescribeReservedInstancesOfferingsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeRouteTables service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeRouteTablesResult`. - - @see AWSEC2DescribeRouteTablesRequest - @see AWSEC2DescribeRouteTablesResult - */ -- (BFTask *)describeRouteTables:(AWSEC2DescribeRouteTablesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeSecurityGroups service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeSecurityGroupsResult`. - - @see AWSEC2DescribeSecurityGroupsRequest - @see AWSEC2DescribeSecurityGroupsResult - */ -- (BFTask *)describeSecurityGroups:(AWSEC2DescribeSecurityGroupsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeSnapshotAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeSnapshotAttributeResult`. - - @see AWSEC2DescribeSnapshotAttributeRequest - @see AWSEC2DescribeSnapshotAttributeResult - */ -- (BFTask *)describeSnapshotAttribute:(AWSEC2DescribeSnapshotAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeSnapshots service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeSnapshotsResult`. - - @see AWSEC2DescribeSnapshotsRequest - @see AWSEC2DescribeSnapshotsResult - */ -- (BFTask *)describeSnapshots:(AWSEC2DescribeSnapshotsRequest *)request; - -/** -Describes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.
- - @param request A container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeSpotDatafeedSubscriptionResult`. - - @see AWSEC2DescribeSpotDatafeedSubscriptionRequest - @see AWSEC2DescribeSpotDatafeedSubscriptionResult - */ -- (BFTask *)describeSpotDatafeedSubscription:(AWSEC2DescribeSpotDatafeedSubscriptionRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeSpotPriceHistory service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeSpotPriceHistoryResult`. - - @see AWSEC2DescribeSpotPriceHistoryRequest - @see AWSEC2DescribeSpotPriceHistoryResult - */ -- (BFTask *)describeSpotPriceHistory:(AWSEC2DescribeSpotPriceHistoryRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeSubnets service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeSubnetsResult`. - - @see AWSEC2DescribeSubnetsRequest - @see AWSEC2DescribeSubnetsResult - */ -- (BFTask *)describeSubnets:(AWSEC2DescribeSubnetsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeTags service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeTagsResult`. - - @see AWSEC2DescribeTagsRequest - @see AWSEC2DescribeTagsResult - */ -- (BFTask *)describeTags:(AWSEC2DescribeTagsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeVolumeAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVolumeAttributeResult`. - - @see AWSEC2DescribeVolumeAttributeRequest - @see AWSEC2DescribeVolumeAttributeResult - */ -- (BFTask *)describeVolumeAttribute:(AWSEC2DescribeVolumeAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeVolumes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVolumesResult`. - - @see AWSEC2DescribeVolumesRequest - @see AWSEC2DescribeVolumesResult - */ -- (BFTask *)describeVolumes:(AWSEC2DescribeVolumesRequest *)request; - -/** -Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
- - @param request A container for the necessary parameters to execute the DescribeVpcAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVpcAttributeResult`. - - @see AWSEC2DescribeVpcAttributeRequest - @see AWSEC2DescribeVpcAttributeResult - */ -- (BFTask *)describeVpcAttribute:(AWSEC2DescribeVpcAttributeRequest *)request; - -/** -Describes one or more of your VPC peering connections.
- - @param request A container for the necessary parameters to execute the DescribeVpcPeeringConnections service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVpcPeeringConnectionsResult`. - - @see AWSEC2DescribeVpcPeeringConnectionsRequest - @see AWSEC2DescribeVpcPeeringConnectionsResult - */ -- (BFTask *)describeVpcPeeringConnections:(AWSEC2DescribeVpcPeeringConnectionsRequest *)request; - -/** -Describes one or more of your VPCs.
- - @param request A container for the necessary parameters to execute the DescribeVpcs service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVpcsResult`. - - @see AWSEC2DescribeVpcsRequest - @see AWSEC2DescribeVpcsResult - */ -- (BFTask *)describeVpcs:(AWSEC2DescribeVpcsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeVpnConnections service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVpnConnectionsResult`. - - @see AWSEC2DescribeVpnConnectionsRequest - @see AWSEC2DescribeVpnConnectionsResult - */ -- (BFTask *)describeVpnConnections:(AWSEC2DescribeVpnConnectionsRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DescribeVpnGateways service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2DescribeVpnGatewaysResult`. - - @see AWSEC2DescribeVpnGatewaysRequest - @see AWSEC2DescribeVpnGatewaysResult - */ -- (BFTask *)describeVpnGateways:(AWSEC2DescribeVpnGatewaysRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DetachInternetGateway service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DetachInternetGatewayRequest - */ -- (BFTask *)detachInternetGateway:(AWSEC2DetachInternetGatewayRequest *)request; - -/** -Detaches a network interface from an instance.
- - @param request A container for the necessary parameters to execute the DetachNetworkInterface service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DetachNetworkInterfaceRequest - */ -- (BFTask *)detachNetworkInterface:(AWSEC2DetachNetworkInterfaceRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DetachVolume service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2VolumeAttachment`. - - @see AWSEC2DetachVolumeRequest - @see AWSEC2VolumeAttachment - */ -- (BFTask *)detachVolume:(AWSEC2DetachVolumeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DisableVgwRoutePropagation service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DisableVgwRoutePropagationRequest - */ -- (BFTask *)disableVgwRoutePropagation:(AWSEC2DisableVgwRoutePropagationRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DisassociateAddress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DisassociateAddressRequest - */ -- (BFTask *)disassociateAddress:(AWSEC2DisassociateAddressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DisassociateRouteTable service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2DisassociateRouteTableRequest - */ -- (BFTask *)disassociateRouteTable:(AWSEC2DisassociateRouteTableRequest *)request; - -/** -Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
- - @param request A container for the necessary parameters to execute the EnableVgwRoutePropagation service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2EnableVgwRoutePropagationRequest - */ -- (BFTask *)enableVgwRoutePropagation:(AWSEC2EnableVgwRoutePropagationRequest *)request; - -/** -Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
- - @param request A container for the necessary parameters to execute the EnableVolumeIO service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2EnableVolumeIORequest - */ -- (BFTask *)enableVolumeIO:(AWSEC2EnableVolumeIORequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetConsoleOutput service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2GetConsoleOutputResult`. - - @see AWSEC2GetConsoleOutputRequest - @see AWSEC2GetConsoleOutputResult - */ -- (BFTask *)getConsoleOutput:(AWSEC2GetConsoleOutputRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetPasswordData service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2GetPasswordDataResult`. - - @see AWSEC2GetPasswordDataRequest - @see AWSEC2GetPasswordDataResult - */ -- (BFTask *)getPasswordData:(AWSEC2GetPasswordDataRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ImportKeyPair service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ImportKeyPairResult`. - - @see AWSEC2ImportKeyPairRequest - @see AWSEC2ImportKeyPairResult - */ -- (BFTask *)importKeyPair:(AWSEC2ImportKeyPairRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ModifyInstanceAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ModifyInstanceAttributeRequest - */ -- (BFTask *)modifyInstanceAttribute:(AWSEC2ModifyInstanceAttributeRequest *)request; - -/** -Modifies the specified network interface attribute. You can specify only one attribute at a time.
- - @param request A container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ModifyNetworkInterfaceAttributeRequest - */ -- (BFTask *)modifyNetworkInterfaceAttribute:(AWSEC2ModifyNetworkInterfaceAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ModifyReservedInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ModifyReservedInstancesResult`. - - @see AWSEC2ModifyReservedInstancesRequest - @see AWSEC2ModifyReservedInstancesResult - */ -- (BFTask *)modifyReservedInstances:(AWSEC2ModifyReservedInstancesRequest *)request; - -/** -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.
Snapshots with AWS Marketplace product codes cannot be made public.
Modifies a subnet attribute.
- - @param request A container for the necessary parameters to execute the ModifySubnetAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ModifySubnetAttributeRequest - */ -- (BFTask *)modifySubnetAttribute:(AWSEC2ModifySubnetAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ModifyVolumeAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ModifyVolumeAttributeRequest - */ -- (BFTask *)modifyVolumeAttribute:(AWSEC2ModifyVolumeAttributeRequest *)request; - -/** -Modifies the specified attribute of the specified VPC.
- - @param request A container for the necessary parameters to execute the ModifyVpcAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ModifyVpcAttributeRequest - */ -- (BFTask *)modifyVpcAttribute:(AWSEC2ModifyVpcAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the MonitorInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2MonitorInstancesResult`. - - @see AWSEC2MonitorInstancesRequest - @see AWSEC2MonitorInstancesResult - */ -- (BFTask *)monitorInstances:(AWSEC2MonitorInstancesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2PurchaseReservedInstancesOfferingResult`. - - @see AWSEC2PurchaseReservedInstancesOfferingRequest - @see AWSEC2PurchaseReservedInstancesOfferingResult - */ -- (BFTask *)purchaseReservedInstancesOffering:(AWSEC2PurchaseReservedInstancesOfferingRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the RebootInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2RebootInstancesRequest - */ -- (BFTask *)rebootInstances:(AWSEC2RebootInstancesRequest *)request; - -/** -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 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.
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.
- - @param request A container for the necessary parameters to execute the ReplaceNetworkAclAssociation service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ReplaceNetworkAclAssociationResult`. - - @see AWSEC2ReplaceNetworkAclAssociationRequest - @see AWSEC2ReplaceNetworkAclAssociationResult - */ -- (BFTask *)replaceNetworkAclAssociation:(AWSEC2ReplaceNetworkAclAssociationRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ReplaceNetworkAclEntry service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ReplaceNetworkAclEntryRequest - */ -- (BFTask *)replaceNetworkAclEntry:(AWSEC2ReplaceNetworkAclEntryRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ReplaceRoute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ReplaceRouteRequest - */ -- (BFTask *)replaceRoute:(AWSEC2ReplaceRouteRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ReplaceRouteTableAssociation service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ReplaceRouteTableAssociationResult`. - - @see AWSEC2ReplaceRouteTableAssociationRequest - @see AWSEC2ReplaceRouteTableAssociationResult - */ -- (BFTask *)replaceRouteTableAssociation:(AWSEC2ReplaceRouteTableAssociationRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ReplicateImage service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ReplicateImageResult`. - - @see AWSEC2ReplicateImageRequest - @see AWSEC2ReplicateImageResult - */ -- (BFTask *)replicateImage:(AWSEC2ReplicateImageRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ReplicateSnapshot service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2ReplicateSnapshotResult`. - - @see AWSEC2ReplicateSnapshotRequest - @see AWSEC2ReplicateSnapshotResult - */ -- (BFTask *)replicateSnapshot:(AWSEC2ReplicateSnapshotRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ReportInstanceStatus service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ReportInstanceStatusRequest - */ -- (BFTask *)reportInstanceStatus:(AWSEC2ReportInstanceStatusRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the RequestSpotInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2RequestSpotInstancesResult`. - - @see AWSEC2RequestSpotInstancesRequest - @see AWSEC2RequestSpotInstancesResult - */ -- (BFTask *)requestSpotInstances:(AWSEC2RequestSpotInstancesRequest *)request; - -/** -Resets an attribute of an AMI to its default value.
- - @param request A container for the necessary parameters to execute the ResetImageAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ResetImageAttributeRequest - */ -- (BFTask *)resetImageAttribute:(AWSEC2ResetImageAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ResetNetworkInterfaceAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ResetNetworkInterfaceAttributeRequest - */ -- (BFTask *)resetNetworkInterfaceAttribute:(AWSEC2ResetNetworkInterfaceAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ResetSnapshotAttribute service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2ResetSnapshotAttributeRequest - */ -- (BFTask *)resetSnapshotAttribute:(AWSEC2ResetSnapshotAttributeRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the RevokeSecurityGroupEgress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2RevokeSecurityGroupEgressRequest - */ -- (BFTask *)revokeSecurityGroupEgress:(AWSEC2RevokeSecurityGroupEgressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the RevokeSecurityGroupIngress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2RevokeSecurityGroupIngressRequest - */ -- (BFTask *)revokeSecurityGroupIngress:(AWSEC2RevokeSecurityGroupIngressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the RunInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2Reservation`. - - @see AWSEC2RunInstancesRequest - @see AWSEC2Reservation - */ -- (BFTask *)runInstances:(AWSEC2RunInstancesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the StartInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2StartInstancesResult`. - - @see AWSEC2StartInstancesRequest - @see AWSEC2StartInstancesResult - */ -- (BFTask *)startInstances:(AWSEC2StartInstancesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the StopInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2StopInstancesResult`. - - @see AWSEC2StopInstancesRequest - @see AWSEC2StopInstancesResult - */ -- (BFTask *)stopInstances:(AWSEC2StopInstancesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the TerminateInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2TerminateInstancesResult`. - - @see AWSEC2TerminateInstancesRequest - @see AWSEC2TerminateInstancesResult - */ -- (BFTask *)terminateInstances:(AWSEC2TerminateInstancesRequest *)request; - -/** -Unassigns one or more secondary private IP addresses from a network interface.
- - @param request A container for the necessary parameters to execute the UnassignPrivateIpAddresses service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSEC2UnassignPrivateIpAddressesRequest - */ -- (BFTask *)unassignPrivateIpAddresses:(AWSEC2UnassignPrivateIpAddressesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the UnmonitorInstances service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSEC2UnmonitorInstancesResult`. - - @see AWSEC2UnmonitorInstancesRequest - @see AWSEC2UnmonitorInstancesResult - */ -- (BFTask *)unmonitorInstances:(AWSEC2UnmonitorInstancesRequest *)request; - -@end diff --git a/Frameworks/AWSEC2.framework/Info.plist b/Frameworks/AWSEC2.framework/Info.plist deleted file mode 100644 index 4671993..0000000 Binary files a/Frameworks/AWSEC2.framework/Info.plist and /dev/null differ diff --git a/Frameworks/AWSEC2.framework/Modules/module.modulemap b/Frameworks/AWSEC2.framework/Modules/module.modulemap deleted file mode 100644 index cfc8e17..0000000 --- a/Frameworks/AWSEC2.framework/Modules/module.modulemap +++ /dev/null @@ -1,6 +0,0 @@ -framework module AWSEC2 { - umbrella header "AWSEC2-umbrella.h" - - export * - module * { export * } -} diff --git a/Frameworks/AWSEC2.framework/_CodeSignature/CodeResources b/Frameworks/AWSEC2.framework/_CodeSignature/CodeResources deleted file mode 100644 index b6a4d7f..0000000 --- a/Frameworks/AWSEC2.framework/_CodeSignature/CodeResources +++ /dev/null @@ -1,159 +0,0 @@ - - -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.
This procedure 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.
" - }, - "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.
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.
" - }, - "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). 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).
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.
" - }, - "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.
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 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.
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 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.
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.
" - }, - "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.
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.
" - }, - "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.
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.
" - }, - "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.
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.
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 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", - "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 (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 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.
", - "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" - } - } - }, - "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. 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" - }, - "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" - }, - "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 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" - }, - "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" - ] - }, - "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/Frameworks/AWSElasticLoadBalancing.framework/AWSElasticLoadBalancing b/Frameworks/AWSElasticLoadBalancing.framework/AWSElasticLoadBalancing deleted file mode 100755 index d352a4e..0000000 Binary files a/Frameworks/AWSElasticLoadBalancing.framework/AWSElasticLoadBalancing and /dev/null differ diff --git a/Frameworks/AWSElasticLoadBalancing.framework/Headers/AWSElasticLoadBalancing-umbrella.h b/Frameworks/AWSElasticLoadBalancing.framework/Headers/AWSElasticLoadBalancing-umbrella.h deleted file mode 100644 index a85081b..0000000 --- a/Frameworks/AWSElasticLoadBalancing.framework/Headers/AWSElasticLoadBalancing-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#importRepresents the input for AddTagsToStream.
The name of the stream.
- */ -@property (nonatomic, strong) NSString *streamName; - -/** -The set of key-value pairs to use to create the tags.
- */ -@property (nonatomic, strong) NSDictionary *tags; - -@end - -/** -Represents the input for CreateStream.
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.
- */ -@property (nonatomic, strong) NSNumber *shardCount; - -/** -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.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the input for DeleteStream.
The name of the stream to delete.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the input for DescribeStream.
The shard ID of the shard to start with.
- */ -@property (nonatomic, strong) NSString *exclusiveStartShardId; - -/** -The maximum number of shards to return.
- */ -@property (nonatomic, strong) NSNumber *limit; - -/** -The name of the stream to describe.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the output 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.
- */ -@property (nonatomic, strong) AWSKinesisStreamDescription *streamDescription; - -@end - -/** -Represents the input for GetRecords.
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.
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.
- */ -@property (nonatomic, strong) NSString *shardIterator; - -@end - -/** -Represents the output for GetRecords.
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.
The data records retrieved from the shard.
- */ -@property (nonatomic, strong) NSArray *records; - -@end - -/** -Represents the input for GetShardIterator.
The shard ID of the shard to get the iterator for.
- */ -@property (nonatomic, strong) NSString *shardId; - -/** -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.
- */ -@property (nonatomic, strong) NSString *startingSequenceNumber; - -/** -The name of the stream.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the output 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.
- */ -@property (nonatomic, strong) NSString *shardIterator; - -@end - -/** -The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
- Required parameters: [StartingHashKey, EndingHashKey] - */ -@interface AWSKinesisHashKeyRange : AWSModel - - -/** -The ending hash key of the hash key range.
- */ -@property (nonatomic, strong) NSString *endingHashKey; - -/** -The starting hash key of the hash key range.
- */ -@property (nonatomic, strong) NSString *startingHashKey; - -@end - -/** -Represents the input for ListStreams.
The name of the stream to start the list with.
- */ -@property (nonatomic, strong) NSString *exclusiveStartStreamName; - -/** -The maximum number of streams to list.
- */ -@property (nonatomic, strong) NSNumber *limit; - -@end - -/** -Represents the output for ListStreams.
If set to true, there are more streams available to list.
The names of the streams that are associated with the AWS account making the ListStreams request.
Represents the input for ListTagsForStream.
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.
The name of the stream.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the output for ListTagsForStream.
If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.
A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
Represents the input for MergeShards.
The shard ID of the adjacent shard for the merge.
- */ -@property (nonatomic, strong) NSString *adjacentShardToMerge; - -/** -The shard ID of the shard to combine with the adjacent shard for the merge.
- */ -@property (nonatomic, strong) NSString *shardToMerge; - -/** -The name of the stream for the merge.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the input for PutRecord.
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)
- */ -@property (nonatomic, strong) NSData *data; - -/** -The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
- */ -@property (nonatomic, strong) NSString *explicitHashKey; - -/** -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.
- */ -@property (nonatomic, strong) NSString *partitionKey; - -/** -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.
The name of the stream to put the data record into.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the output for PutRecord.
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.
- */ -@property (nonatomic, strong) NSString *sequenceNumber; - -/** -The shard ID of the shard where the data record was placed.
- */ -@property (nonatomic, strong) NSString *shardId; - -@end - -/** -A PutRecords request.
The records associated with the request.
- */ -@property (nonatomic, strong) NSArray *records; - -/** -The stream name associated with the request.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -PutRecords results.
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.
Represents the output for PutRecords.
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)
- */ -@property (nonatomic, strong) NSData *data; - -/** -The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
- */ -@property (nonatomic, strong) NSString *explicitHashKey; - -/** -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.
- */ -@property (nonatomic, strong) NSString *partitionKey; - -@end - -/** -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 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".
The sequence number for an individual record result.
- */ -@property (nonatomic, strong) NSString *sequenceNumber; - -/** -The shard ID for an individual record result.
- */ -@property (nonatomic, strong) NSString *shardId; - -@end - -/** -The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.
- Required parameters: [SequenceNumber, Data, PartitionKey] - */ -@interface AWSKinesisRecord : AWSModel - - -/** -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)
- */ -@property (nonatomic, strong) NSData *data; - -/** -Identifies which shard in the stream the data record is assigned to.
- */ -@property (nonatomic, strong) NSString *partitionKey; - -/** -The unique identifier for the record in the Amazon Kinesis stream.
- */ -@property (nonatomic, strong) NSString *sequenceNumber; - -@end - -/** -Represents the input for RemoveTagsFromStream.
The name of the stream.
- */ -@property (nonatomic, strong) NSString *streamName; - -/** -A list of tag keys. Each corresponding tag is removed from the stream.
- */ -@property (nonatomic, strong) NSArray *tagKeys; - -@end - -/** -The range of possible sequence numbers for the shard.
- Required parameters: [StartingSequenceNumber] - */ -@interface AWSKinesisSequenceNumberRange : AWSModel - - -/** -The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
The starting sequence number for the range.
- */ -@property (nonatomic, strong) NSString *startingSequenceNumber; - -@end - -/** -A uniquely identified group of data records in an Amazon Kinesis stream.
- Required parameters: [ShardId, HashKeyRange, SequenceNumberRange] - */ -@interface AWSKinesisShard : AWSModel - - -/** -The shard Id of the shard adjacent to the shard's parent.
- */ -@property (nonatomic, strong) NSString *adjacentParentShardId; - -/** -The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
- */ -@property (nonatomic, strong) AWSKinesisHashKeyRange *hashKeyRange; - -/** -The shard Id of the shard's parent.
- */ -@property (nonatomic, strong) NSString *parentShardId; - -/** -The range of possible sequence numbers for the shard.
- */ -@property (nonatomic, strong) AWSKinesisSequenceNumberRange *sequenceNumberRange; - -/** -The unique identifier of the shard within the Amazon Kinesis stream.
- */ -@property (nonatomic, strong) NSString *shardId; - -@end - -/** -Represents the input for SplitShard.
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.
The shard ID of the shard to split.
- */ -@property (nonatomic, strong) NSString *shardToSplit; - -/** -The name of the stream for the shard split.
- */ -@property (nonatomic, strong) NSString *streamName; - -@end - -/** -Represents the output for DescribeStream.
If set to true, more shards in the stream are available to describe.
The shards that comprise the stream.
- */ -@property (nonatomic, strong) NSArray *shards; - -/** -The Amazon Resource Name (ARN) for the stream being described.
- */ -@property (nonatomic, strong) NSString *streamARN; - -/** -The name of the stream being described.
- */ -@property (nonatomic, strong) NSString *streamName; - -/** -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.Metadata assigned to the stream, consisting of a key-value pair.
- Required parameters: [Key] - */ -@interface AWSKinesisTag : AWSModel - - -/** -A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
- */ -@property (nonatomic, strong) NSString *key; - -/** -An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
- */ -@property (nonatomic, strong) NSString *value; - -@end diff --git a/Frameworks/AWSKinesis.framework/Headers/AWSKinesisRecorder.h b/Frameworks/AWSKinesis.framework/Headers/AWSKinesisRecorder.h deleted file mode 100644 index 6fbb516..0000000 --- a/Frameworks/AWSKinesis.framework/Headers/AWSKinesisRecorder.h +++ /dev/null @@ -1,243 +0,0 @@ -/* - * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"). - * You may not use this file except in compliance with the License. - * A copy of the License is located at - * - http://aws.amazon.com/apache2.0 - * - * or in the "license" file accompanying this file. This file is distributed - * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - * express or implied. See the License for the specific language governing - * permissions and limitations under the License. - */ - -#importAmazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.
- */ -@interface AWSKinesis : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let Kinesis = AWSKinesis.defaultKinesis() - - *Objective-C* - - AWSKinesis *Kinesis = [AWSKinesis defaultKinesis]; - - @return The default service client. - */ -+ (instancetype)defaultKinesis; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSKinesis.registerKinesisWithConfiguration(configuration, forKey: "USWest2Kinesis") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSKinesis registerKinesisWithConfiguration:configuration forKey:@"USWest2Kinesis"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let Kinesis = AWSKinesis(forKey: "USWest2Kinesis") - - *Objective-C* - - AWSKinesis *Kinesis = [AWSKinesis KinesisForKey:@"USWest2Kinesis"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerKinesisWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerKinesisWithConfiguration:forKey:` before invoking this method. If `+ registerKinesisWithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSKinesis.registerKinesisWithConfiguration(configuration, forKey: "USWest2Kinesis") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSKinesis registerKinesisWithConfiguration:configuration forKey:@"USWest2Kinesis"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let Kinesis = AWSKinesis(forKey: "USWest2Kinesis") - - *Objective-C* - - AWSKinesis *Kinesis = [AWSKinesis KinesisForKey:@"USWest2Kinesis"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)KinesisForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeKinesisForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerKinesisWithConfiguration:forKey:` and `+ KinesisForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerKinesisWithConfiguration:forKey:' and '+ KinesisForKey:' instead."))); - -/** -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.
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.
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.
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.
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.
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.
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.
Lists the tags for the specified Amazon Kinesis stream.
- - @param request A container for the necessary parameters to execute the ListTagsForStream service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSKinesisListTagsForStreamOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSKinesisErrorDomain` domian and the following error code: `AWSKinesisErrorResourceNotFound`, `AWSKinesisErrorInvalidArgument`, `AWSKinesisErrorLimitExceeded`. - - @see AWSKinesisListTagsForStreamInput - @see AWSKinesisListTagsForStreamOutput - */ -- (BFTask *)listTagsForStream:(AWSKinesisListTagsForStreamInput *)request; - -/** -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.
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.
- - @param request A container for the necessary parameters to execute the PutRecord service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSKinesisPutRecordOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSKinesisErrorDomain` domian and the following error code: `AWSKinesisErrorResourceNotFound`, `AWSKinesisErrorInvalidArgument`, `AWSKinesisErrorProvisionedThroughputExceeded`. - - @see AWSKinesisPutRecordInput - @see AWSKinesisPutRecordOutput - */ -- (BFTask *)putRecord:(AWSKinesisPutRecordInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the PutRecords service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSKinesisPutRecordsOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSKinesisErrorDomain` domian and the following error code: `AWSKinesisErrorResourceNotFound`, `AWSKinesisErrorInvalidArgument`, `AWSKinesisErrorProvisionedThroughputExceeded`. - - @see AWSKinesisPutRecordsInput - @see AWSKinesisPutRecordsOutput - */ -- (BFTask *)putRecords:(AWSKinesisPutRecordsInput *)request; - -/** -Deletes tags from the specified Amazon Kinesis stream.
If you specify a tag that does not exist, it is ignored.
- - @param request A container for the necessary parameters to execute the RemoveTagsFromStream service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSKinesisErrorDomain` domian and the following error code: `AWSKinesisErrorResourceNotFound`, `AWSKinesisErrorResourceInUse`, `AWSKinesisErrorInvalidArgument`, `AWSKinesisErrorLimitExceeded`. - - @see AWSKinesisRemoveTagsFromStreamInput - */ -- (BFTask *)removeTagsFromStream:(AWSKinesisRemoveTagsFromStreamInput *)request; - -/** -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.
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/Frameworks/AWSMobileAnalytics.framework/AWSMobileAnalytics b/Frameworks/AWSMobileAnalytics.framework/AWSMobileAnalytics new file mode 100755 index 0000000..17541ab Binary files /dev/null and b/Frameworks/AWSMobileAnalytics.framework/AWSMobileAnalytics differ diff --git a/Frameworks/AWSMobileAnalytics.framework/Headers/AWSMobileAnalytics-umbrella.h b/Frameworks/AWSMobileAnalytics.framework/Headers/AWSMobileAnalytics-umbrella.h new file mode 100644 index 0000000..35f4beb --- /dev/null +++ b/Frameworks/AWSMobileAnalytics.framework/Headers/AWSMobileAnalytics-umbrella.h @@ -0,0 +1,19 @@ +#importAborts 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.
- - @param request A container for the necessary parameters to execute the AbortMultipartUpload service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchUpload`. - - @see AWSS3AbortMultipartUploadRequest - */ -- (BFTask *)abortMultipartUpload:(AWSS3AbortMultipartUploadRequest *)request; - -/** - Completes a multipart upload by assembling previously uploaded parts. - - @param request A container for the necessary parameters to execute the CompleteMultipartUpload service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3CompleteMultipartUploadOutput`. - - @see AWSS3CompleteMultipartUploadRequest - @see AWSS3CompleteMultipartUploadOutput - */ -- (BFTask *)completeMultipartUpload:(AWSS3CompleteMultipartUploadRequest *)request; - -/** - Creates a new bucket. - - @param request A container for the necessary parameters to execute the CreateBucket service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3CreateBucketOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorBucketAlreadyExists`. - - @see AWSS3CreateBucketRequest - @see AWSS3CreateBucketOutput - */ -- (BFTask *)createBucket:(AWSS3CreateBucketRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the CreateMultipartUpload service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3CreateMultipartUploadOutput`. - - @see AWSS3CreateMultipartUploadRequest - @see AWSS3CreateMultipartUploadOutput - */ -- (BFTask *)createMultipartUpload:(AWSS3CreateMultipartUploadRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the DeleteBucket service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3DeleteBucketRequest - */ -- (BFTask *)deleteBucket:(AWSS3DeleteBucketRequest *)request; - -/** - Deletes the cors configuration information set for the bucket. - - @param request A container for the necessary parameters to execute the DeleteBucketCors service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3DeleteBucketCorsRequest - */ -- (BFTask *)deleteBucketCors:(AWSS3DeleteBucketCorsRequest *)request; - -/** - Deletes the lifecycle configuration from the bucket. - - @param request A container for the necessary parameters to execute the DeleteBucketLifecycle service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3DeleteBucketLifecycleRequest - */ -- (BFTask *)deleteBucketLifecycle:(AWSS3DeleteBucketLifecycleRequest *)request; - -/** - Deletes the policy from the bucket. - - @param request A container for the necessary parameters to execute the DeleteBucketPolicy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3DeleteBucketPolicyRequest - */ -- (BFTask *)deleteBucketPolicy:(AWSS3DeleteBucketPolicyRequest *)request; - -/** - Deletes the tags from the bucket. - - @param request A container for the necessary parameters to execute the DeleteBucketTagging service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3DeleteBucketTaggingRequest - */ -- (BFTask *)deleteBucketTagging:(AWSS3DeleteBucketTaggingRequest *)request; - -/** - This operation removes the website configuration from the bucket. - - @param request A container for the necessary parameters to execute the DeleteBucketWebsite service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3DeleteBucketWebsiteRequest - */ -- (BFTask *)deleteBucketWebsite:(AWSS3DeleteBucketWebsiteRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the DeleteObject service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3DeleteObjectOutput`. - - @see AWSS3DeleteObjectRequest - @see AWSS3DeleteObjectOutput - */ -- (BFTask *)deleteObject:(AWSS3DeleteObjectRequest *)request; - -/** - This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys. - - @param request A container for the necessary parameters to execute the DeleteObjects service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3DeleteObjectsOutput`. - - @see AWSS3DeleteObjectsRequest - @see AWSS3DeleteObjectsOutput - */ -- (BFTask *)deleteObjects:(AWSS3DeleteObjectsRequest *)request; - -/** - Gets the access control policy for the bucket. - - @param request A container for the necessary parameters to execute the GetBucketAcl service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketAclOutput`. - - @see AWSS3GetBucketAclRequest - @see AWSS3GetBucketAclOutput - */ -- (BFTask *)getBucketAcl:(AWSS3GetBucketAclRequest *)request; - -/** - Returns the cors configuration for the bucket. - - @param request A container for the necessary parameters to execute the GetBucketCors service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketCorsOutput`. - - @see AWSS3GetBucketCorsRequest - @see AWSS3GetBucketCorsOutput - */ -- (BFTask *)getBucketCors:(AWSS3GetBucketCorsRequest *)request; - -/** - Returns the lifecycle configuration information set on the bucket. - - @param request A container for the necessary parameters to execute the GetBucketLifecycle service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketLifecycleOutput`. - - @see AWSS3GetBucketLifecycleRequest - @see AWSS3GetBucketLifecycleOutput - */ -- (BFTask *)getBucketLifecycle:(AWSS3GetBucketLifecycleRequest *)request; - -/** - Returns the region the bucket resides in. - - @param request A container for the necessary parameters to execute the GetBucketLocation service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketLocationOutput`. - - @see AWSS3GetBucketLocationRequest - @see AWSS3GetBucketLocationOutput - */ -- (BFTask *)getBucketLocation:(AWSS3GetBucketLocationRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the GetBucketLogging service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketLoggingOutput`. - - @see AWSS3GetBucketLoggingRequest - @see AWSS3GetBucketLoggingOutput - */ -- (BFTask *)getBucketLogging:(AWSS3GetBucketLoggingRequest *)request; - -/** - Return the notification configuration of a bucket. - - @param request A container for the necessary parameters to execute the GetBucketNotification service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketNotificationOutput`. - - @see AWSS3GetBucketNotificationRequest - @see AWSS3GetBucketNotificationOutput - */ -- (BFTask *)getBucketNotification:(AWSS3GetBucketNotificationRequest *)request; - -/** - Returns the policy of a specified bucket. - - @param request A container for the necessary parameters to execute the GetBucketPolicy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketPolicyOutput`. - - @see AWSS3GetBucketPolicyRequest - @see AWSS3GetBucketPolicyOutput - */ -- (BFTask *)getBucketPolicy:(AWSS3GetBucketPolicyRequest *)request; - -/** - Returns the request payment configuration of a bucket. - - @param request A container for the necessary parameters to execute the GetBucketRequestPayment service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketRequestPaymentOutput`. - - @see AWSS3GetBucketRequestPaymentRequest - @see AWSS3GetBucketRequestPaymentOutput - */ -- (BFTask *)getBucketRequestPayment:(AWSS3GetBucketRequestPaymentRequest *)request; - -/** - Returns the tag set associated with the bucket. - - @param request A container for the necessary parameters to execute the GetBucketTagging service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketTaggingOutput`. - - @see AWSS3GetBucketTaggingRequest - @see AWSS3GetBucketTaggingOutput - */ -- (BFTask *)getBucketTagging:(AWSS3GetBucketTaggingRequest *)request; - -/** - Returns the versioning state of a bucket. - - @param request A container for the necessary parameters to execute the GetBucketVersioning service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketVersioningOutput`. - - @see AWSS3GetBucketVersioningRequest - @see AWSS3GetBucketVersioningOutput - */ -- (BFTask *)getBucketVersioning:(AWSS3GetBucketVersioningRequest *)request; - -/** - Returns the website configuration for a bucket. - - @param request A container for the necessary parameters to execute the GetBucketWebsite service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetBucketWebsiteOutput`. - - @see AWSS3GetBucketWebsiteRequest - @see AWSS3GetBucketWebsiteOutput - */ -- (BFTask *)getBucketWebsite:(AWSS3GetBucketWebsiteRequest *)request; - -/** - Retrieves objects from Amazon S3. - - @param request A container for the necessary parameters to execute the GetObject service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetObjectOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchKey`. - - @see AWSS3GetObjectRequest - @see AWSS3GetObjectOutput - */ -- (BFTask *)getObject:(AWSS3GetObjectRequest *)request; - -/** - Returns the access control list (ACL) of an object. - - @param request A container for the necessary parameters to execute the GetObjectAcl service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetObjectAclOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchKey`. - - @see AWSS3GetObjectAclRequest - @see AWSS3GetObjectAclOutput - */ -- (BFTask *)getObjectAcl:(AWSS3GetObjectAclRequest *)request; - -/** - Return torrent files from a bucket. - - @param request A container for the necessary parameters to execute the GetObjectTorrent service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3GetObjectTorrentOutput`. - - @see AWSS3GetObjectTorrentRequest - @see AWSS3GetObjectTorrentOutput - */ -- (BFTask *)getObjectTorrent:(AWSS3GetObjectTorrentRequest *)request; - -/** - This operation is useful to determine if a bucket exists and you have permission to access it. - - @param request A container for the necessary parameters to execute the HeadBucket service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchBucket`. - - @see AWSS3HeadBucketRequest - */ -- (BFTask *)headBucket:(AWSS3HeadBucketRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the HeadObject service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3HeadObjectOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchKey`. - - @see AWSS3HeadObjectRequest - @see AWSS3HeadObjectOutput - */ -- (BFTask *)headObject:(AWSS3HeadObjectRequest *)request; - -/** - Returns a list of all buckets owned by the authenticated sender of the request. - - @param request A container for the necessary parameters to execute the ListBuckets service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3ListBucketsOutput`. - - @see AWSRequest - @see AWSS3ListBucketsOutput - */ -- (BFTask *)listBuckets:(AWSRequest *)request; - -/** - This operation lists in-progress multipart uploads. - - @param request A container for the necessary parameters to execute the ListMultipartUploads service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3ListMultipartUploadsOutput`. - - @see AWSS3ListMultipartUploadsRequest - @see AWSS3ListMultipartUploadsOutput - */ -- (BFTask *)listMultipartUploads:(AWSS3ListMultipartUploadsRequest *)request; - -/** - Returns metadata about all of the versions of objects in a bucket. - - @param request A container for the necessary parameters to execute the ListObjectVersions service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3ListObjectVersionsOutput`. - - @see AWSS3ListObjectVersionsRequest - @see AWSS3ListObjectVersionsOutput - */ -- (BFTask *)listObjectVersions:(AWSS3ListObjectVersionsRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the ListObjects service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3ListObjectsOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchBucket`. - - @see AWSS3ListObjectsRequest - @see AWSS3ListObjectsOutput - */ -- (BFTask *)listObjects:(AWSS3ListObjectsRequest *)request; - -/** - Lists the parts that have been uploaded for a specific multipart upload. - - @param request A container for the necessary parameters to execute the ListParts service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3ListPartsOutput`. - - @see AWSS3ListPartsRequest - @see AWSS3ListPartsOutput - */ -- (BFTask *)listParts:(AWSS3ListPartsRequest *)request; - -/** - Sets the permissions on a bucket using access control lists (ACL). - - @param request A container for the necessary parameters to execute the PutBucketAcl service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketAclRequest - */ -- (BFTask *)putBucketAcl:(AWSS3PutBucketAclRequest *)request; - -/** - Sets the cors configuration for a bucket. - - @param request A container for the necessary parameters to execute the PutBucketCors service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketCorsRequest - */ -- (BFTask *)putBucketCors:(AWSS3PutBucketCorsRequest *)request; - -/** - Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. - - @param request A container for the necessary parameters to execute the PutBucketLifecycle service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketLifecycleRequest - */ -- (BFTask *)putBucketLifecycle:(AWSS3PutBucketLifecycleRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the PutBucketLogging service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketLoggingRequest - */ -- (BFTask *)putBucketLogging:(AWSS3PutBucketLoggingRequest *)request; - -/** - Enables notifications of specified events for a bucket. - - @param request A container for the necessary parameters to execute the PutBucketNotification service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketNotificationRequest - */ -- (BFTask *)putBucketNotification:(AWSS3PutBucketNotificationRequest *)request; - -/** - Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. - - @param request A container for the necessary parameters to execute the PutBucketPolicy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketPolicyRequest - */ -- (BFTask *)putBucketPolicy:(AWSS3PutBucketPolicyRequest *)request; - -/** - 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. - - @param request A container for the necessary parameters to execute the PutBucketRequestPayment service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketRequestPaymentRequest - */ -- (BFTask *)putBucketRequestPayment:(AWSS3PutBucketRequestPaymentRequest *)request; - -/** - Sets the tags for a bucket. - - @param request A container for the necessary parameters to execute the PutBucketTagging service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketTaggingRequest - */ -- (BFTask *)putBucketTagging:(AWSS3PutBucketTaggingRequest *)request; - -/** - Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. - - @param request A container for the necessary parameters to execute the PutBucketVersioning service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketVersioningRequest - */ -- (BFTask *)putBucketVersioning:(AWSS3PutBucketVersioningRequest *)request; - -/** - Set the website configuration for a bucket. - - @param request A container for the necessary parameters to execute the PutBucketWebsite service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSS3PutBucketWebsiteRequest - */ -- (BFTask *)putBucketWebsite:(AWSS3PutBucketWebsiteRequest *)request; - -/** - Adds an object to a bucket. - - @param request A container for the necessary parameters to execute the PutObject service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3PutObjectOutput`. - - @see AWSS3PutObjectRequest - @see AWSS3PutObjectOutput - */ -- (BFTask *)putObject:(AWSS3PutObjectRequest *)request; - -/** - uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket - - @param request A container for the necessary parameters to execute the PutObjectAcl service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorNoSuchKey`. - - @see AWSS3PutObjectAclRequest - */ -- (BFTask *)putObjectAcl:(AWSS3PutObjectAclRequest *)request; - -/** - Creates a copy of an object that is already stored in Amazon S3. - - @param request A container for the necessary parameters to execute the ReplicateObject service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3ReplicateObjectOutput`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorObjectNotInActiveTier`. - - @see AWSS3ReplicateObjectRequest - @see AWSS3ReplicateObjectOutput - */ -- (BFTask *)replicateObject:(AWSS3ReplicateObjectRequest *)request; - -/** - Restores an archived copy of an object back into Amazon S3 - - @param request A container for the necessary parameters to execute the RestoreObject service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSS3ErrorDomain` domian and the following error code: `AWSS3ErrorObjectAlreadyInActiveTier`. - - @see AWSS3RestoreObjectRequest - */ -- (BFTask *)restoreObject:(AWSS3RestoreObjectRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the UploadPart service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3UploadPartOutput`. - - @see AWSS3UploadPartRequest - @see AWSS3UploadPartOutput - */ -- (BFTask *)uploadPart:(AWSS3UploadPartRequest *)request; - -/** - Uploads a part by copying data from an existing object as data source. - - @param request A container for the necessary parameters to execute the UploadPartCopy service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSS3UploadPartCopyOutput`. - - @see AWSS3UploadPartCopyRequest - @see AWSS3UploadPartCopyOutput - */ -- (BFTask *)uploadPartCopy:(AWSS3UploadPartCopyRequest *)request; - -@end diff --git a/Frameworks/AWSS3.framework/Headers/AWSS3TransferManager.h b/Frameworks/AWSS3.framework/Headers/AWSS3TransferManager.h deleted file mode 100644 index 08fee2c..0000000 --- a/Frameworks/AWSS3.framework/Headers/AWSS3TransferManager.h +++ /dev/null @@ -1,253 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importAborts 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/Frameworks/AWSSES.framework/AWSSES b/Frameworks/AWSSES.framework/AWSSES deleted file mode 100755 index 215f882..0000000 Binary files a/Frameworks/AWSSES.framework/AWSSES and /dev/null differ diff --git a/Frameworks/AWSSES.framework/Headers/AWSSES-umbrella.h b/Frameworks/AWSSES.framework/Headers/AWSSES-umbrella.h deleted file mode 100644 index add6408..0000000 --- a/Frameworks/AWSSES.framework/Headers/AWSSES-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#importRepresents 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.
- */ -@interface AWSSESBody : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) AWSSESContent *html; - -/** -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).
- */ -@property (nonatomic, strong) AWSSESContent *text; - -@end - -/** -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.
- Required parameters: [Data] - */ -@interface AWSSESContent : AWSModel - - -/** -The character set of the content.
- */ -@property (nonatomic, strong) NSString *charset; - -/** -The textual data of the content.
- */ -@property (nonatomic, strong) NSString *data; - -@end - -/** -Represents a request instructing the service to delete an identity from the list of identities for the AWS Account.
- Required parameters: [Identity] - */ -@interface AWSSESDeleteIdentityRequest : AWSRequest - - -/** -The identity to be removed from the list of identities for the AWS Account.
- */ -@property (nonatomic, strong) NSString *identity; - -@end - -/** -An empty element. Receiving this element indicates that the request completed successfully.
- */ -@interface AWSSESDeleteIdentityResponse : AWSModel - - -@end - -/** -Represents a request instructing the service to delete an address from the list of verified email addresses.
- Required parameters: [EmailAddress] - */ -@interface AWSSESDeleteVerifiedEmailAddressRequest : AWSRequest - - -/** -An email address to be removed from the list of verified addresses.
- */ -@property (nonatomic, strong) NSString *emailAddress; - -@end - -/** -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.
The BCC: field(s) of the message.
- */ -@property (nonatomic, strong) NSArray *bccAddresses; - -/** -The CC: field(s) of the message.
- */ -@property (nonatomic, strong) NSArray *ccAddresses; - -/** -The To: field(s) of the message.
- */ -@property (nonatomic, strong) NSArray *toAddresses; - -@end - -/** -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.
- Required parameters: [Identities] - */ -@interface AWSSESGetIdentityDkimAttributesRequest : AWSRequest - - -/** -A list of one or more verified identities - email addresses, domains, or both.
- */ -@property (nonatomic, strong) NSArray *identities; - -@end - -/** -Represents a list of all the DKIM attributes for the specified identity.
- Required parameters: [DkimAttributes] - */ -@interface AWSSESGetIdentityDkimAttributesResponse : AWSModel - - -/** -The DKIM attributes for an email address or a domain.
- */ -@property (nonatomic, strong) NSDictionary *dkimAttributes; - -@end - -/** - - */ -@interface AWSSESGetIdentityNotificationAttributesRequest : AWSRequest - - -/** -A list of one or more identities.
- */ -@property (nonatomic, strong) NSArray *identities; - -@end - -/** -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.
- Required parameters: [NotificationAttributes] - */ -@interface AWSSESGetIdentityNotificationAttributesResponse : AWSModel - - -/** -A map of Identity to IdentityNotificationAttributes.
- */ -@property (nonatomic, strong) NSDictionary *notificationAttributes; - -@end - -/** -Represents a request instructing the service to provide the verification attributes for a list of identities.
- Required parameters: [Identities] - */ -@interface AWSSESGetIdentityVerificationAttributesRequest : AWSRequest - - -/** -A list of identities.
- */ -@property (nonatomic, strong) NSArray *identities; - -@end - -/** -Represents the verification attributes for a list of identities.
- Required parameters: [VerificationAttributes] - */ -@interface AWSSESGetIdentityVerificationAttributesResponse : AWSModel - - -/** -A map of Identities to IdentityVerificationAttributes objects.
- */ -@property (nonatomic, strong) NSDictionary *verificationAttributes; - -@end - -/** -Represents the user's current activity limits returned from a successful GetSendQuota request.
The maximum number of emails the user is allowed to send in a 24-hour interval.
- */ -@property (nonatomic, strong) NSNumber *max24HourSend; - -/** -The maximum number of emails the user is allowed to send per second.
- */ -@property (nonatomic, strong) NSNumber *maxSendRate; - -/** -The number of emails sent during the previous 24 hours.
- */ -@property (nonatomic, strong) NSNumber *sentLast24Hours; - -@end - -/** -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.
A list of data points, each of which represents 15 minutes of activity.
- */ -@property (nonatomic, strong) NSArray *sendDataPoints; - -@end - -/** -Represents the DKIM attributes of a verified email address or a domain.
- Required parameters: [DkimEnabled, DkimVerificationStatus] - */ -@interface AWSSESIdentityDkimAttributes : AWSModel - - -/** -True if DKIM signing is enabled for email sent from the identity; false otherwise.
- */ -@property (nonatomic, strong) NSNumber *dkimEnabled; - -/** -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.
- */ -@property (nonatomic, strong) NSArray *dkimTokens; - -/** -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.)
- */ -@property (nonatomic, assign) AWSSESVerificationStatus dkimVerificationStatus; - -@end - -/** -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.
- Required parameters: [BounceTopic, ComplaintTopic, DeliveryTopic, ForwardingEnabled] - */ -@interface AWSSESIdentityNotificationAttributes : AWSModel - - -/** -The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
- */ -@property (nonatomic, strong) NSString *bounceTopic; - -/** -The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
- */ -@property (nonatomic, strong) NSString *complaintTopic; - -/** -The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
- */ -@property (nonatomic, strong) NSString *deliveryTopic; - -/** -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 verification attributes of a single identity.
- Required parameters: [VerificationStatus] - */ -@interface AWSSESIdentityVerificationAttributes : AWSModel - - -/** -The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
- */ -@property (nonatomic, assign) AWSSESVerificationStatus verificationStatus; - -/** -The verification token for a domain identity. Null for email address identities.
- */ -@property (nonatomic, strong) NSString *verificationToken; - -@end - -/** -Represents a request instructing the service to list all identities for the AWS Account.
- */ -@interface AWSSESListIdentitiesRequest : AWSRequest - - -/** -The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.
- */ -@property (nonatomic, assign) AWSSESIdentityType identityType; - -/** -The maximum number of identities per page. Possible values are 1-100 inclusive.
- */ -@property (nonatomic, strong) NSNumber *maxItems; - -/** -The token to use for pagination.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -Represents a list of all verified identities for the AWS Account.
- Required parameters: [Identities] - */ -@interface AWSSESListIdentitiesResponse : AWSModel - - -/** -A list of identities.
- */ -@property (nonatomic, strong) NSArray *identities; - -/** -The token used for pagination.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -Represents a list of all the email addresses verified for the current user.
- */ -@interface AWSSESListVerifiedEmailAddressesResponse : AWSModel - - -/** -A list of email addresses that have been verified.
- */ -@property (nonatomic, strong) NSArray *verifiedEmailAddresses; - -@end - -/** -Represents the message to be sent, composed of a subject and a body.
- Required parameters: [Subject, Body] - */ -@interface AWSSESMessage : AWSModel - - -/** -The message body.
- */ -@property (nonatomic, strong) AWSSESBody *body; - -/** -The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
- */ -@property (nonatomic, strong) AWSSESContent *subject; - -@end - -/** -Represents the raw data of the message.
- Required parameters: [Data] - */ -@interface AWSSESRawMessage : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSData *data; - -@end - -/** -Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.
Number of emails that have bounced.
- */ -@property (nonatomic, strong) NSNumber *bounces; - -/** -Number of unwanted emails that were rejected by recipients.
- */ -@property (nonatomic, strong) NSNumber *complaints; - -/** -Number of emails that have been enqueued for sending.
- */ -@property (nonatomic, strong) NSNumber *deliveryAttempts; - -/** -Number of emails rejected by Amazon SES.
- */ -@property (nonatomic, strong) NSNumber *rejects; - -/** -Time of the data point.
- */ -@property (nonatomic, strong) NSDate *timestamp; - -@end - -/** -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 destination for this email, composed of To:, CC:, and BCC: fields.
- */ -@property (nonatomic, strong) AWSSESDestination *destination; - -/** -The message to be sent.
- */ -@property (nonatomic, strong) AWSSESMessage *message; - -/** -The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
- */ -@property (nonatomic, strong) NSArray *replyToAddresses; - -/** -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.
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.
Represents a unique message ID returned from a successful SendEmail request.
The unique message identifier returned from the SendEmail action.
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.
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
- */ -@property (nonatomic, strong) NSArray *destinations; - -/** -The raw text of the message. The client is responsible for ensuring the following:
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.
Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message. Represents a unique message ID returned from a successful SendRawEmail request.
The unique message identifier returned from the SendRawEmail action.
Represents a request instructing the service to enable or disable DKIM signing for an identity.
- Required parameters: [Identity, DkimEnabled] - */ -@interface AWSSESSetIdentityDkimEnabledRequest : AWSRequest - - -/** -Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
The identity for which DKIM signing should be enabled or disabled.
- */ -@property (nonatomic, strong) NSString *identity; - -@end - -/** -An empty element. Receiving this element indicates that the request completed successfully.
- */ -@interface AWSSESSetIdentityDkimEnabledResponse : AWSModel - - -@end - -/** - - */ -@interface AWSSESSetIdentityFeedbackForwardingEnabledRequest : AWSRequest - - -/** -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.
The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.
An empty element. Receiving this element indicates that the request completed successfully.
- */ -@interface AWSSESSetIdentityFeedbackForwardingEnabledResponse : AWSModel - - -@end - -/** -Represents a request to set or clear an identity's notification topic.
- Required parameters: [Identity, NotificationType] - */ -@interface AWSSESSetIdentityNotificationTopicRequest : AWSRequest - - -/** -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.
- */ -@property (nonatomic, assign) AWSSESNotificationType notificationType; - -/** -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.
An empty element. Receiving this element indicates that the request completed successfully.
- */ -@interface AWSSESSetIdentityNotificationTopicResponse : AWSModel - - -@end - -/** -Represents a request instructing the service to begin DKIM verification for a domain.
- Required parameters: [Domain] - */ -@interface AWSSESVerifyDomainDkimRequest : AWSRequest - - -/** -The name of the domain to be verified for Easy DKIM signing.
- */ -@property (nonatomic, strong) NSString *domain; - -@end - -/** -Represents the DNS records that must be published in the domain name's DNS to complete DKIM setup.
- Required parameters: [DkimTokens] - */ -@interface AWSSESVerifyDomainDkimResponse : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSArray *dkimTokens; - -@end - -/** -Represents a request instructing the service to begin domain verification.
- Required parameters: [Domain] - */ -@interface AWSSESVerifyDomainIdentityRequest : AWSRequest - - -/** -The domain to be verified.
- */ -@property (nonatomic, strong) NSString *domain; - -@end - -/** -Represents a token used for domain ownership verification.
- Required parameters: [VerificationToken] - */ -@interface AWSSESVerifyDomainIdentityResponse : AWSModel - - -/** -A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.
- */ -@property (nonatomic, strong) NSString *verificationToken; - -@end - -/** -Represents a request instructing the service to begin email address verification.
- Required parameters: [EmailAddress] - */ -@interface AWSSESVerifyEmailAddressRequest : AWSRequest - - -/** -The email address to be verified.
- */ -@property (nonatomic, strong) NSString *emailAddress; - -@end - -/** -Represents a request instructing the service to begin email address verification.
- Required parameters: [EmailAddress] - */ -@interface AWSSESVerifyEmailIdentityRequest : AWSRequest - - -/** -The email address to be verified.
- */ -@property (nonatomic, strong) NSString *emailAddress; - -@end - -/** -An empty element. Receiving this element indicates that the request completed successfully.
- */ -@interface AWSSESVerifyEmailIdentityResponse : AWSModel - - -@end diff --git a/Frameworks/AWSSES.framework/Headers/AWSSESService.h b/Frameworks/AWSSES.framework/Headers/AWSSESService.h deleted file mode 100644 index 006c5d9..0000000 --- a/Frameworks/AWSSES.framework/Headers/AWSSESService.h +++ /dev/null @@ -1,399 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importThis 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.
Deletes the specified identity (email address or domain) from the list of verified identities.
This action is throttled at one request per second.
- - @param request A container for the necessary parameters to execute the DeleteIdentity service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESDeleteIdentityResponse`. - - @see AWSSESDeleteIdentityRequest - @see AWSSESDeleteIdentityResponse - */ -- (BFTask *)deleteIdentity:(AWSSESDeleteIdentityRequest *)request; - -/** -Deletes the specified email address from the list of verified addresses.
This action is throttled at one request per second.
- - @param request A container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSSESDeleteVerifiedEmailAddressRequest - */ -- (BFTask *)deleteVerifiedEmailAddress:(AWSSESDeleteVerifiedEmailAddressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetIdentityDkimAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESGetIdentityDkimAttributesResponse`. - - @see AWSSESGetIdentityDkimAttributesRequest - @see AWSSESGetIdentityDkimAttributesResponse - */ -- (BFTask *)getIdentityDkimAttributes:(AWSSESGetIdentityDkimAttributesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetIdentityNotificationAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESGetIdentityNotificationAttributesResponse`. - - @see AWSSESGetIdentityNotificationAttributesRequest - @see AWSSESGetIdentityNotificationAttributesResponse - */ -- (BFTask *)getIdentityNotificationAttributes:(AWSSESGetIdentityNotificationAttributesRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetIdentityVerificationAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESGetIdentityVerificationAttributesResponse`. - - @see AWSSESGetIdentityVerificationAttributesRequest - @see AWSSESGetIdentityVerificationAttributesResponse - */ -- (BFTask *)getIdentityVerificationAttributes:(AWSSESGetIdentityVerificationAttributesRequest *)request; - -/** -Returns the user's current sending limits.
This action is throttled at one request per second.
- - @param request A container for the necessary parameters to execute the GetSendQuota service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESGetSendQuotaResponse`. - - @see AWSRequest - @see AWSSESGetSendQuotaResponse - */ -- (BFTask *)getSendQuota:(AWSRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetSendStatistics service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESGetSendStatisticsResponse`. - - @see AWSRequest - @see AWSSESGetSendStatisticsResponse - */ -- (BFTask *)getSendStatistics:(AWSRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the ListIdentities service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESListIdentitiesResponse`. - - @see AWSSESListIdentitiesRequest - @see AWSSESListIdentitiesResponse - */ -- (BFTask *)listIdentities:(AWSSESListIdentitiesRequest *)request; - -/** -Returns a list containing all of the email addresses that have been verified.
This action is throttled at one request per second.
- - @param request A container for the necessary parameters to execute the ListVerifiedEmailAddresses service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESListVerifiedEmailAddressesResponse`. - - @see AWSRequest - @see AWSSESListVerifiedEmailAddressesResponse - */ -- (BFTask *)listVerifiedEmailAddresses:(AWSRequest *)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.
- - @param request A container for the necessary parameters to execute the SendEmail service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESSendEmailResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSESErrorDomain` domian and the following error code: `AWSSESErrorMessageRejected`. - - @see AWSSESSendEmailRequest - @see AWSSESSendEmailResponse - */ -- (BFTask *)sendEmail:(AWSSESSendEmailRequest *)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.
- - @param request A container for the necessary parameters to execute the SendRawEmail service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESSendRawEmailResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSESErrorDomain` domian and the following error code: `AWSSESErrorMessageRejected`. - - @see AWSSESSendRawEmailRequest - @see AWSSESSendRawEmailResponse - */ -- (BFTask *)sendRawEmail:(AWSSESSendRawEmailRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the SetIdentityDkimEnabled service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESSetIdentityDkimEnabledResponse`. - - @see AWSSESSetIdentityDkimEnabledRequest - @see AWSSESSetIdentityDkimEnabledResponse - */ -- (BFTask *)setIdentityDkimEnabled:(AWSSESSetIdentityDkimEnabledRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESSetIdentityFeedbackForwardingEnabledResponse`. - - @see AWSSESSetIdentityFeedbackForwardingEnabledRequest - @see AWSSESSetIdentityFeedbackForwardingEnabledResponse - */ -- (BFTask *)setIdentityFeedbackForwardingEnabled:(AWSSESSetIdentityFeedbackForwardingEnabledRequest *)request; - -/** -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.
SetIdentityFeedbackForwardingEnabled. This action is throttled at one request per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
- - @param request A container for the necessary parameters to execute the SetIdentityNotificationTopic service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESSetIdentityNotificationTopicResponse`. - - @see AWSSESSetIdentityNotificationTopicRequest - @see AWSSESSetIdentityNotificationTopicResponse - */ -- (BFTask *)setIdentityNotificationTopic:(AWSSESSetIdentityNotificationTopicRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the VerifyDomainDkim service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESVerifyDomainDkimResponse`. - - @see AWSSESVerifyDomainDkimRequest - @see AWSSESVerifyDomainDkimResponse - */ -- (BFTask *)verifyDomainDkim:(AWSSESVerifyDomainDkimRequest *)request; - -/** -Verifies a domain.
This action is throttled at one request per second.
- - @param request A container for the necessary parameters to execute the VerifyDomainIdentity service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESVerifyDomainIdentityResponse`. - - @see AWSSESVerifyDomainIdentityRequest - @see AWSSESVerifyDomainIdentityResponse - */ -- (BFTask *)verifyDomainIdentity:(AWSSESVerifyDomainIdentityRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the VerifyEmailAddress service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSSESVerifyEmailAddressRequest - */ -- (BFTask *)verifyEmailAddress:(AWSSESVerifyEmailAddressRequest *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the VerifyEmailIdentity service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSESVerifyEmailIdentityResponse`. - - @see AWSSESVerifyEmailIdentityRequest - @see AWSSESVerifyEmailIdentityResponse - */ -- (BFTask *)verifyEmailIdentity:(AWSSESVerifyEmailIdentityRequest *)request; - -@end diff --git a/Frameworks/AWSSES.framework/Info.plist b/Frameworks/AWSSES.framework/Info.plist deleted file mode 100644 index 1e1781d..0000000 Binary files a/Frameworks/AWSSES.framework/Info.plist and /dev/null differ diff --git a/Frameworks/AWSSES.framework/Modules/module.modulemap b/Frameworks/AWSSES.framework/Modules/module.modulemap deleted file mode 100644 index 1530e6f..0000000 --- a/Frameworks/AWSSES.framework/Modules/module.modulemap +++ /dev/null @@ -1,6 +0,0 @@ -framework module AWSSES { - umbrella header "AWSSES-umbrella.h" - - export * - module * { export * } -} diff --git a/Frameworks/AWSSES.framework/_CodeSignature/CodeResources b/Frameworks/AWSSES.framework/_CodeSignature/CodeResources deleted file mode 100644 index 2808446..0000000 --- a/Frameworks/AWSSES.framework/_CodeSignature/CodeResources +++ /dev/null @@ -1,159 +0,0 @@ - - -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.
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.
SetIdentityFeedbackForwardingEnabled. 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.
Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message. 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/Frameworks/AWSSNS.framework/AWSSNS b/Frameworks/AWSSNS.framework/AWSSNS deleted file mode 100755 index 907aeee..0000000 Binary files a/Frameworks/AWSSNS.framework/AWSSNS and /dev/null differ diff --git a/Frameworks/AWSSNS.framework/Headers/AWSSNS-umbrella.h b/Frameworks/AWSSNS.framework/Headers/AWSSNS-umbrella.h deleted file mode 100644 index e2fe43b..0000000 --- a/Frameworks/AWSSNS.framework/Headers/AWSSNS-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#importThe 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.
- */ -@property (nonatomic, strong) NSArray *AWSAccountId; - -/** -The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
- */ -@property (nonatomic, strong) NSArray *actionName; - -/** -A unique identifier for the new policy statement.
- */ -@property (nonatomic, strong) NSString *label; - -/** -The ARN of the topic whose access control policy you wish to modify.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** - Input for ConfirmSubscription action. - Required parameters: [TopicArn, Token] - */ -@interface AWSSNSConfirmSubscriptionInput : AWSRequest - - -/** -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.
Short-lived token sent to an endpoint during the Subscribe action.
The ARN of the topic for which you wish to confirm a subscription.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** - Response for ConfirmSubscriptions action. - */ -@interface AWSSNSConfirmSubscriptionResponse : AWSModel - - -/** -The ARN of the created subscription.
- */ -@property (nonatomic, strong) NSString *subscriptionArn; - -@end - -/** -Response from CreateEndpoint action.
- */ -@interface AWSSNSCreateEndpointResponse : AWSModel - - -/** -EndpointArn returned from CreateEndpoint action.
- */ -@property (nonatomic, strong) NSString *endpointArn; - -@end - -/** -Input for CreatePlatformApplication action.
- Required parameters: [Name, Platform, Attributes] - */ -@interface AWSSNSCreatePlatformApplicationInput : AWSRequest - - -/** -For a list of attributes, see SetPlatformApplicationAttributes
- */ -@property (nonatomic, strong) NSDictionary *attributes; - -/** -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.
- */ -@property (nonatomic, strong) NSString *name; - -/** -The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
- */ -@property (nonatomic, strong) NSString *platform; - -@end - -/** -Response from CreatePlatformApplication action.
- */ -@interface AWSSNSCreatePlatformApplicationResponse : AWSModel - - -/** -PlatformApplicationArn is returned.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -@end - -/** -Input for CreatePlatformEndpoint action.
- Required parameters: [PlatformApplicationArn, Token] - */ -@interface AWSSNSCreatePlatformEndpointInput : AWSRequest - - -/** -For a list of attributes, see SetEndpointAttributes.
- */ -@property (nonatomic, strong) NSDictionary *attributes; - -/** -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.
- */ -@property (nonatomic, strong) NSString *customUserData; - -/** -PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -/** -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.
- */ -@property (nonatomic, strong) NSString *token; - -@end - -/** -Input for CreateTopic action.
- Required parameters: [Name] - */ -@interface AWSSNSCreateTopicInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *name; - -@end - -/** -Response from CreateTopic action.
- */ -@interface AWSSNSCreateTopicResponse : AWSModel - - -/** -The Amazon Resource Name (ARN) assigned to the created topic.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Input for DeleteEndpoint action.
- Required parameters: [EndpointArn] - */ -@interface AWSSNSDeleteEndpointInput : AWSRequest - - -/** -EndpointArn of endpoint to delete.
- */ -@property (nonatomic, strong) NSString *endpointArn; - -@end - -/** -Input for DeletePlatformApplication action.
- Required parameters: [PlatformApplicationArn] - */ -@interface AWSSNSDeletePlatformApplicationInput : AWSRequest - - -/** -PlatformApplicationArn of platform application object to delete.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -@end - -/** - - */ -@interface AWSSNSDeleteTopicInput : AWSRequest - - -/** -The ARN of the topic you want to delete.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Endpoint for mobile app and device.
- */ -@interface AWSSNSEndpoint : AWSModel - - -/** -Attributes for endpoint.
- */ -@property (nonatomic, strong) NSDictionary *attributes; - -/** -EndpointArn for mobile app and device.
- */ -@property (nonatomic, strong) NSString *endpointArn; - -@end - -/** -Input for GetEndpointAttributes action.
- Required parameters: [EndpointArn] - */ -@interface AWSSNSGetEndpointAttributesInput : AWSRequest - - -/** -EndpointArn for GetEndpointAttributes input.
- */ -@property (nonatomic, strong) NSString *endpointArn; - -@end - -/** -Response from GetEndpointAttributes of the EndpointArn.
- */ -@interface AWSSNSGetEndpointAttributesResponse : AWSModel - - -/** -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.Input for GetPlatformApplicationAttributes action.
- Required parameters: [PlatformApplicationArn] - */ -@interface AWSSNSGetPlatformApplicationAttributesInput : AWSRequest - - -/** -PlatformApplicationArn for GetPlatformApplicationAttributesInput.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -@end - -/** -Response for GetPlatformApplicationAttributes action.
- */ -@interface AWSSNSGetPlatformApplicationAttributesResponse : AWSModel - - -/** -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.Input for GetSubscriptionAttributes.
- Required parameters: [SubscriptionArn] - */ -@interface AWSSNSGetSubscriptionAttributesInput : AWSRequest - - -/** -The ARN of the subscription whose properties you want to get.
- */ -@property (nonatomic, strong) NSString *subscriptionArn; - -@end - -/** -Response for GetSubscriptionAttributes action.
- */ -@interface AWSSNSGetSubscriptionAttributesResponse : AWSModel - - -/** -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 defaultsInput for GetTopicAttributes action.
- Required parameters: [TopicArn] - */ -@interface AWSSNSGetTopicAttributesInput : AWSRequest - - -/** -The ARN of the topic whose properties you want to get.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Response for GetTopicAttributes action.
- */ -@interface AWSSNSGetTopicAttributesResponse : AWSModel - - -/** -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 defaultsInput for ListEndpointsByPlatformApplication action.
- Required parameters: [PlatformApplicationArn] - */ -@interface AWSSNSListEndpointsByPlatformApplicationInput : AWSRequest - - -/** -NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -@end - -/** -Response for ListEndpointsByPlatformApplication action.
- */ -@interface AWSSNSListEndpointsByPlatformApplicationResponse : AWSModel - - -/** -Endpoints returned for ListEndpointsByPlatformApplication action.
- */ -@property (nonatomic, strong) NSArray *endpoints; - -/** -NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -Input for ListPlatformApplications action.
- */ -@interface AWSSNSListPlatformApplicationsInput : AWSRequest - - -/** -NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -@end - -/** -Response for ListPlatformApplications action.
- */ -@interface AWSSNSListPlatformApplicationsResponse : AWSModel - - -/** -NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
- */ -@property (nonatomic, strong) NSString *nextToken; - -/** -Platform applications returned when calling ListPlatformApplications action.
- */ -@property (nonatomic, strong) NSArray *platformApplications; - -@end - -/** -Input for ListSubscriptionsByTopic action.
- Required parameters: [TopicArn] - */ -@interface AWSSNSListSubscriptionsByTopicInput : AWSRequest - - -/** -Token returned by the previous ListSubscriptionsByTopic request.
The ARN of the topic for which you wish to find subscriptions.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Response for ListSubscriptionsByTopic action.
- */ -@interface AWSSNSListSubscriptionsByTopicResponse : AWSModel - - -/** -Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.
A list of subscriptions.
- */ -@property (nonatomic, strong) NSArray *subscriptions; - -@end - -/** - Input for ListSubscriptions action. - */ -@interface AWSSNSListSubscriptionsInput : AWSRequest - - -/** -Token returned by the previous ListSubscriptions request.
Response for ListSubscriptions action
- */ -@interface AWSSNSListSubscriptionsResponse : AWSModel - - -/** -Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
A list of subscriptions.
- */ -@property (nonatomic, strong) NSArray *subscriptions; - -@end - -/** - - */ -@interface AWSSNSListTopicsInput : AWSRequest - - -/** -Token returned by the previous ListTopics request.
Response for ListTopics action.
- */ -@interface AWSSNSListTopicsResponse : AWSModel - - -/** -Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
A list of topic ARNs.
- */ -@property (nonatomic, strong) NSArray *topics; - -@end - -/** -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.
- Required parameters: [DataType] - */ -@interface AWSSNSMessageAttributeValue : AWSModel - - -/** -Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
- */ -@property (nonatomic, strong) NSData *binaryValue; - -/** -Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
- */ -@property (nonatomic, strong) NSString *dataType; - -/** -Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
- */ -@property (nonatomic, strong) NSString *stringValue; - -@end - -/** -Platform application object.
- */ -@interface AWSSNSPlatformApplication : AWSModel - - -/** -Attributes for platform application object.
- */ -@property (nonatomic, strong) NSDictionary *attributes; - -/** -PlatformApplicationArn for platform application object.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -@end - -/** -Input for Publish action.
- Required parameters: [Message] - */ -@interface AWSSNSPublishInput : AWSRequest - - -/** -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).Message attributes for Publish action.
- */ -@property (nonatomic, strong) NSDictionary *messageAttributes; - -/** -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
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.
- */ -@property (nonatomic, strong) NSString *subject; - -/** -Either TopicArn or EndpointArn, but not both.
- */ -@property (nonatomic, strong) NSString *targetArn; - -/** -The topic you want to publish to.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Response for Publish action.
- */ -@interface AWSSNSPublishResponse : AWSModel - - -/** -Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
- */ -@property (nonatomic, strong) NSString *messageId; - -@end - -/** -Input for RemovePermission action.
- Required parameters: [TopicArn, Label] - */ -@interface AWSSNSRemovePermissionInput : AWSRequest - - -/** -The unique label of the statement you want to remove.
- */ -@property (nonatomic, strong) NSString *label; - -/** -The ARN of the topic whose access control policy you wish to modify.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Input for SetEndpointAttributes action.
- Required parameters: [EndpointArn, Attributes] - */ -@interface AWSSNSSetEndpointAttributesInput : AWSRequest - - -/** -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.EndpointArn used for SetEndpointAttributes action.
- */ -@property (nonatomic, strong) NSString *endpointArn; - -@end - -/** -Input for SetPlatformApplicationAttributes action.
- Required parameters: [PlatformApplicationArn, Attributes] - */ -@interface AWSSNSSetPlatformApplicationAttributesInput : AWSRequest - - -/** -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.PlatformApplicationArn for SetPlatformApplicationAttributes action.
- */ -@property (nonatomic, strong) NSString *platformApplicationArn; - -@end - -/** -Input for SetSubscriptionAttributes action.
- Required parameters: [SubscriptionArn, AttributeName] - */ -@interface AWSSNSSetSubscriptionAttributesInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *attributeValue; - -/** -The ARN of the subscription to modify.
- */ -@property (nonatomic, strong) NSString *subscriptionArn; - -@end - -/** -Input for SetTopicAttributes action.
- Required parameters: [TopicArn, AttributeName] - */ -@interface AWSSNSSetTopicAttributesInput : AWSRequest - - -/** -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.
- */ -@property (nonatomic, strong) NSString *attributeValue; - -/** -The ARN of the topic to modify.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** - Input for Subscribe action. - Required parameters: [TopicArn, Protocol] - */ -@interface AWSSNSSubscribeInput : AWSRequest - - -/** -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 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 ARN of the topic you want to subscribe to.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** - Response for Subscribe action. - */ -@interface AWSSNSSubscribeResponse : AWSModel - - -/** -The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
- */ -@property (nonatomic, strong) NSString *subscriptionArn; - -@end - -/** -A wrapper type for the attributes of an Amazon SNS subscription.
- */ -@interface AWSSNSSubscription : AWSModel - - -/** -The subscription's endpoint (format depends on the protocol).
- */ -@property (nonatomic, strong) NSString *endpoint; - -/** -The subscription's owner.
- */ -@property (nonatomic, strong) NSString *owner; - -/** -The subscription's protocol.
- */ -@property (nonatomic, strong) NSString *protocols; - -/** -The subscription's ARN.
- */ -@property (nonatomic, strong) NSString *subscriptionArn; - -/** -The ARN of the subscription's topic.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
The topic's ARN.
- */ -@property (nonatomic, strong) NSString *topicArn; - -@end - -/** -Input for Unsubscribe action.
- Required parameters: [SubscriptionArn] - */ -@interface AWSSNSUnsubscribeInput : AWSRequest - - -/** -The ARN of the subscription to be deleted.
- */ -@property (nonatomic, strong) NSString *subscriptionArn; - -@end diff --git a/Frameworks/AWSSNS.framework/Headers/AWSSNSService.h b/Frameworks/AWSSNS.framework/Headers/AWSSNSService.h deleted file mode 100644 index 640ce3b..0000000 --- a/Frameworks/AWSSNS.framework/Headers/AWSSNSService.h +++ /dev/null @@ -1,475 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importAmazon 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.
- */ -@interface AWSSNS : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let SNS = AWSSNS.defaultSNS() - - *Objective-C* - - AWSSNS *SNS = [AWSSNS defaultSNS]; - - @return The default service client. - */ -+ (instancetype)defaultSNS; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSSNS.registerSNSWithConfiguration(configuration, forKey: "USWest2SNS") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSSNS registerSNSWithConfiguration:configuration forKey:@"USWest2SNS"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let SNS = AWSSNS(forKey: "USWest2SNS") - - *Objective-C* - - AWSSNS *SNS = [AWSSNS SNSForKey:@"USWest2SNS"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerSNSWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerSNSWithConfiguration:forKey:` before invoking this method. If `+ registerSNSWithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSSNS.registerSNSWithConfiguration(configuration, forKey: "USWest2SNS") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSSNS registerSNSWithConfiguration:configuration forKey:@"USWest2SNS"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let SNS = AWSSNS(forKey: "USWest2SNS") - - *Objective-C* - - AWSSNS *SNS = [AWSSNS SNSForKey:@"USWest2SNS"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)SNSForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeSNSForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerSNSWithConfiguration:forKey:` and `+ SNSForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerSNSWithConfiguration:forKey:' and '+ SNSForKey:' instead."))); - -/** -Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
- - @param request A container for the necessary parameters to execute the AddPermission service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSAddPermissionInput - */ -- (BFTask *)addPermission:(AWSSNSAddPermissionInput *)request; - -/** -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".
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.
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.
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.
- - @param request A container for the necessary parameters to execute the CreateTopic service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSNSCreateTopicResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorTopicLimitExceeded`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSCreateTopicInput - @see AWSSNSCreateTopicResponse - */ -- (BFTask *)createTopic:(AWSSNSCreateTopicInput *)request; - -/** -Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
- - @param request A container for the necessary parameters to execute the DeleteEndpoint service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSDeleteEndpointInput - */ -- (BFTask *)deleteEndpoint:(AWSSNSDeleteEndpointInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeletePlatformApplication service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSDeletePlatformApplicationInput - */ -- (BFTask *)deletePlatformApplication:(AWSSNSDeletePlatformApplicationInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the DeleteTopic service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSDeleteTopicInput - */ -- (BFTask *)deleteTopic:(AWSSNSDeleteTopicInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetEndpointAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSNSGetEndpointAttributesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSGetEndpointAttributesInput - @see AWSSNSGetEndpointAttributesResponse - */ -- (BFTask *)getEndpointAttributes:(AWSSNSGetEndpointAttributesInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the GetPlatformApplicationAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSNSGetPlatformApplicationAttributesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSGetPlatformApplicationAttributesInput - @see AWSSNSGetPlatformApplicationAttributesResponse - */ -- (BFTask *)getPlatformApplicationAttributes:(AWSSNSGetPlatformApplicationAttributesInput *)request; - -/** -Returns all of the properties of a subscription.
- - @param request A container for the necessary parameters to execute the GetSubscriptionAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSNSGetSubscriptionAttributesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorNotFound`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSGetSubscriptionAttributesInput - @see AWSSNSGetSubscriptionAttributesResponse - */ -- (BFTask *)getSubscriptionAttributes:(AWSSNSGetSubscriptionAttributesInput *)request; - -/** -Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
- - @param request A container for the necessary parameters to execute the GetTopicAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSNSGetTopicAttributesResponse`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorNotFound`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSGetTopicAttributesInput - @see AWSSNSGetTopicAttributesResponse - */ -- (BFTask *)getTopicAttributes:(AWSSNSGetTopicAttributesInput *)request; - -/** -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.
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.
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.
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.
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.
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.
Removes a statement from a topic's access control policy.
- - @param request A container for the necessary parameters to execute the RemovePermission service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSRemovePermissionInput - */ -- (BFTask *)removePermission:(AWSSNSRemovePermissionInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the SetEndpointAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSSetEndpointAttributesInput - */ -- (BFTask *)setEndpointAttributes:(AWSSNSSetEndpointAttributesInput *)request; - -/** -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.
- - @param request A container for the necessary parameters to execute the SetPlatformApplicationAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorAuthorizationError`, `AWSSNSErrorNotFound`. - - @see AWSSNSSetPlatformApplicationAttributesInput - */ -- (BFTask *)setPlatformApplicationAttributes:(AWSSNSSetPlatformApplicationAttributesInput *)request; - -/** -Allows a subscription owner to set an attribute of the topic to a new value.
- - @param request A container for the necessary parameters to execute the SetSubscriptionAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorNotFound`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSSetSubscriptionAttributesInput - */ -- (BFTask *)setSubscriptionAttributes:(AWSSNSSetSubscriptionAttributesInput *)request; - -/** -Allows a topic owner to set an attribute of the topic to a new value.
- - @param request A container for the necessary parameters to execute the SetTopicAttributes service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSNSErrorDomain` domian and the following error code: `AWSSNSErrorInvalidParameter`, `AWSSNSErrorInternalError`, `AWSSNSErrorNotFound`, `AWSSNSErrorAuthorizationError`. - - @see AWSSNSSetTopicAttributesInput - */ -- (BFTask *)setTopicAttributes:(AWSSNSSetTopicAttributesInput *)request; - -/** -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.
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.
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/Frameworks/AWSSQS.framework/AWSSQS b/Frameworks/AWSSQS.framework/AWSSQS deleted file mode 100755 index 832fd7e..0000000 Binary files a/Frameworks/AWSSQS.framework/AWSSQS and /dev/null differ diff --git a/Frameworks/AWSSQS.framework/Headers/AWSSQS-umbrella.h b/Frameworks/AWSSQS.framework/Headers/AWSSQS-umbrella.h deleted file mode 100644 index ef5bf3f..0000000 --- a/Frameworks/AWSSQS.framework/Headers/AWSSQS-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#importThe 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.
- */ -@property (nonatomic, strong) NSArray *AWSAccountIds; - -/** -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 unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** -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.
- Required parameters: [Id, SenderFault, Code] - */ -@interface AWSSQSBatchResultErrorEntry : AWSModel - - -/** -An error code representing why the action failed on this entry.
- */ -@property (nonatomic, strong) NSString *code; - -/** -The id of an entry in a batch request.
- */ -@property (nonatomic, strong) NSString *identifier; - -/** -A message explaining why the action failed on this entry.
- */ -@property (nonatomic, strong) NSString *message; - -/** -Whether the error happened due to the sender's fault.
- */ -@property (nonatomic, strong) NSNumber *senderFault; - -@end - -/** - - */ -@interface AWSSQSChangeMessageVisibilityBatchRequest : AWSRequest - - -/** -A list of receipt handles of the messages for which the visibility timeout must be changed.
- */ -@property (nonatomic, strong) NSArray *entries; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** -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
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.
- */ -@property (nonatomic, strong) NSString *receiptHandle; - -/** -The new value (in seconds) for the message's visibility timeout.
- */ -@property (nonatomic, strong) NSNumber *visibilityTimeout; - -@end - -/** -For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
- Required parameters: [Successful, Failed] - */ -@interface AWSSQSChangeMessageVisibilityBatchResult : AWSModel - - -/** -A list of BatchResultErrorEntry items.
- */ -@property (nonatomic, strong) NSArray *failed; - -/** -A list of ChangeMessageVisibilityBatchResultEntry items.
- */ -@property (nonatomic, strong) NSArray *successful; - -@end - -/** -Encloses the id of an entry in ChangeMessageVisibilityBatch.
- Required parameters: [Id] - */ -@interface AWSSQSChangeMessageVisibilityBatchResultEntry : AWSModel - - -/** -Represents a message whose visibility timeout has been changed successfully.
- */ -@property (nonatomic, strong) NSString *identifier; - -@end - -/** - - */ -@interface AWSSQSChangeMessageVisibilityRequest : AWSRequest - - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -/** -The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
- */ -@property (nonatomic, strong) NSString *receiptHandle; - -/** -The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
- */ -@property (nonatomic, strong) NSNumber *visibilityTimeout; - -@end - -/** - - */ -@interface AWSSQSCreateQueueRequest : AWSRequest - - -/** -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 form-url-encoded policy. For more information about policy structure, see Basic Policy Structure in the Amazon SQS Developer Guide. For more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.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 name for the queue to be created.
- */ -@property (nonatomic, strong) NSString *queueName; - -@end - -/** -Returns the QueueUrl element of the created queue.
- */ -@interface AWSSQSCreateQueueResult : AWSModel - - -/** -The URL for the created Amazon SQS queue.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** - - */ -@interface AWSSQSDeleteMessageBatchRequest : AWSRequest - - -/** -A list of receipt handles for the messages to be deleted.
- */ -@property (nonatomic, strong) NSArray *entries; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** -Encloses a receipt handle and an identifier for it.
- Required parameters: [Id, ReceiptHandle] - */ -@interface AWSSQSDeleteMessageBatchRequestEntry : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *receiptHandle; - -@end - -/** -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.
- Required parameters: [Successful, Failed] - */ -@interface AWSSQSDeleteMessageBatchResult : AWSModel - - -/** -A list of BatchResultErrorEntry items.
- */ -@property (nonatomic, strong) NSArray *failed; - -/** -A list of DeleteMessageBatchResultEntry items.
- */ -@property (nonatomic, strong) NSArray *successful; - -@end - -/** -Encloses the id an entry in DeleteMessageBatch.
- Required parameters: [Id] - */ -@interface AWSSQSDeleteMessageBatchResultEntry : AWSModel - - -/** -Represents a successfully deleted message.
- */ -@property (nonatomic, strong) NSString *identifier; - -@end - -/** - - */ -@interface AWSSQSDeleteMessageRequest : AWSRequest - - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -/** -The receipt handle associated with the message to delete.
- */ -@property (nonatomic, strong) NSString *receiptHandle; - -@end - -/** - - */ -@interface AWSSQSDeleteQueueRequest : AWSRequest - - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** - - */ -@interface AWSSQSGetQueueAttributesRequest : AWSRequest - - -/** -A list of attributes to retrieve information for.
- */ -@property (nonatomic, strong) NSArray *attributeNames; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** - A list of returned queue attributes. - */ -@interface AWSSQSGetQueueAttributesResult : AWSModel - - -/** -A map of attributes to the respective values.
- */ -@property (nonatomic, strong) NSDictionary *attributes; - -@end - -/** - - */ -@interface AWSSQSGetQueueUrlRequest : AWSRequest - - -/** -The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
- */ -@property (nonatomic, strong) NSString *queueName; - -/** -The AWS account ID of the account that created the queue.
- */ -@property (nonatomic, strong) NSString *queueOwnerAWSAccountId; - -@end - -/** -For more information, see Responses in the Amazon SQS Developer Guide.
- */ -@interface AWSSQSGetQueueUrlResult : AWSModel - - -/** -The URL for the queue.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** - - */ -@interface AWSSQSListDeadLetterSourceQueuesRequest : AWSRequest - - -/** - The queue URL of a dead letter queue. - */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** - A list of your dead letter source queues. - Required parameters: [queueUrls] - */ -@interface AWSSQSListDeadLetterSourceQueuesResult : AWSModel - - -/** - A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue. - */ -@property (nonatomic, strong) NSArray *queueUrls; - -@end - -/** - - */ -@interface AWSSQSListQueuesRequest : AWSRequest - - -/** -A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
- */ -@property (nonatomic, strong) NSString *queueNamePrefix; - -@end - -/** - A list of your queues. - */ -@interface AWSSQSListQueuesResult : AWSModel - - -/** -A list of queue URLs, up to 1000 entries.
- */ -@property (nonatomic, strong) NSArray *queueUrls; - -@end - -/** -An Amazon SQS message.
- */ -@interface AWSSQSMessage : AWSModel - - -/** -SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.
The message's contents (not URL-encoded).
- */ -@property (nonatomic, strong) NSString *body; - -/** -An MD5 digest of the non-URL-encoded message body string.
- */ -@property (nonatomic, strong) NSString *MD5OfBody; - -/** -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.
- */ -@property (nonatomic, strong) NSString *MD5OfMessageAttributes; - -/** -Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
- */ -@property (nonatomic, strong) NSDictionary *messageAttributes; - -/** -A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.
- */ -@property (nonatomic, strong) NSString *messageId; - -/** -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.
- */ -@property (nonatomic, strong) NSString *receiptHandle; - -@end - -/** -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).
- Required parameters: [DataType] - */ -@interface AWSSQSMessageAttributeValue : AWSModel - - -/** -Not implemented. Reserved for future use.
- */ -@property (nonatomic, strong) NSArray *binaryListValues; - -/** -Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
- */ -@property (nonatomic, strong) NSData *binaryValue; - -/** -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.
- */ -@property (nonatomic, strong) NSString *dataType; - -/** -Not implemented. Reserved for future use.
- */ -@property (nonatomic, strong) NSArray *stringListValues; - -/** -Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
- */ -@property (nonatomic, strong) NSString *stringValue; - -@end - -/** - - */ -@interface AWSSQSReceiveMessageRequest : AWSRequest - - -/** -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 (epoch time in milliseconds).ApproximateReceiveCount - returns the number of times a message has been received 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 (epoch time in milliseconds).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.
- */ -@property (nonatomic, strong) NSNumber *maxNumberOfMessages; - -/** -The message attribute Name can contain the following characters: A-Z, a-z, 0-9, underscore(_), hyphen(-), and period (.). The message attribute name must not start or end with a period, and it should not have successive periods. The message attribute name is case sensitive and must be unique among all attribute names for the message. The message attribute name can be up to 256 characters long. Attribute names cannot start with "AWS." or "Amazon." because these prefixes are reserved for use by Amazon Web Services.
- */ -@property (nonatomic, strong) NSArray *messageAttributeNames; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -/** -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.
- */ -@property (nonatomic, strong) NSNumber *waitTimeSeconds; - -@end - -/** - A list of received messages. - */ -@interface AWSSQSReceiveMessageResult : AWSModel - - -/** -A list of messages.
- */ -@property (nonatomic, strong) NSArray *messages; - -@end - -/** - - */ -@interface AWSSQSRemovePermissionRequest : AWSRequest - - -/** -The identification of the permission to remove. This is the label added with the AddPermission action.
- */ -@property (nonatomic, strong) NSString *label; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** - - */ -@interface AWSSQSSendMessageBatchRequest : AWSRequest - - -/** -A list of SendMessageBatchRequestEntry items.
- */ -@property (nonatomic, strong) NSArray *entries; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** -Contains the details of a single Amazon SQS message along with a Id.
The number of seconds for which the message has to be delayed.
- */ -@property (nonatomic, strong) NSNumber *delaySeconds; - -/** -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.
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
- */ -@property (nonatomic, strong) NSDictionary *messageAttributes; - -/** -Body of the message.
- */ -@property (nonatomic, strong) NSString *messageBody; - -@end - -/** -For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
- Required parameters: [Successful, Failed] - */ -@interface AWSSQSSendMessageBatchResult : AWSModel - - -/** -A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.
- */ -@property (nonatomic, strong) NSArray *failed; - -/** -A list of SendMessageBatchResultEntry items.
- */ -@property (nonatomic, strong) NSArray *successful; - -@end - -/** -Encloses a message ID for successfully enqueued message of a SendMessageBatch.
- Required parameters: [Id, MessageId, MD5OfMessageBody] - */ -@interface AWSSQSSendMessageBatchResultEntry : AWSModel - - -/** -An identifier for the message in this batch.
- */ -@property (nonatomic, strong) NSString *identifier; - -/** -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.
- */ -@property (nonatomic, strong) NSString *MD5OfMessageAttributes; - -/** -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.
- */ -@property (nonatomic, strong) NSString *MD5OfMessageBody; - -/** -An identifier for the message.
- */ -@property (nonatomic, strong) NSString *messageId; - -@end - -/** - - */ -@interface AWSSQSSendMessageRequest : AWSRequest - - -/** - 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.
- */ -@property (nonatomic, strong) NSDictionary *messageAttributes; - -/** -The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
- */ -@property (nonatomic, strong) NSString *messageBody; - -/** -The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end - -/** -The MD5OfMessageBody and MessageId elements.
- */ -@interface AWSSQSSendMessageResult : AWSModel - - -/** -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.
- */ -@property (nonatomic, strong) NSString *MD5OfMessageAttributes; - -/** -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.
- */ -@property (nonatomic, strong) NSString *MD5OfMessageBody; - -/** -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.
- */ -@property (nonatomic, strong) NSString *messageId; - -@end - -/** - - */ -@interface AWSSQSSetQueueAttributesRequest : AWSRequest - - -/** -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 form-url-encoded policy. For more information about policy structure, see Basic Policy Structure in the Amazon SQS Developer Guide. For more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.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.The URL of the Amazon SQS queue to take action on.
- */ -@property (nonatomic, strong) NSString *queueUrl; - -@end diff --git a/Frameworks/AWSSQS.framework/Headers/AWSSQSService.h b/Frameworks/AWSSQS.framework/Headers/AWSSQSService.h deleted file mode 100644 index bc0cb19..0000000 --- a/Frameworks/AWSSQS.framework/Headers/AWSSQSService.h +++ /dev/null @@ -1,371 +0,0 @@ -/* - Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"). - You may not use this file except in compliance with the License. - A copy of the License is located at - - http://aws.amazon.com/apache2.0 - - or in the "license" file accompanying this file. This file is distributed - on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either - express or implied. See the License for the specific language governing - permissions and limitations under the License. - */ - -#importWelcome 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.
- */ -@interface AWSSQS : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let SQS = AWSSQS.defaultSQS() - - *Objective-C* - - AWSSQS *SQS = [AWSSQS defaultSQS]; - - @return The default service client. - */ -+ (instancetype)defaultSQS; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSSQS.registerSQSWithConfiguration(configuration, forKey: "USWest2SQS") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSSQS registerSQSWithConfiguration:configuration forKey:@"USWest2SQS"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let SQS = AWSSQS(forKey: "USWest2SQS") - - *Objective-C* - - AWSSQS *SQS = [AWSSQS SQSForKey:@"USWest2SQS"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerSQSWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerSQSWithConfiguration:forKey:` before invoking this method. If `+ registerSQSWithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSSQS.registerSQSWithConfiguration(configuration, forKey: "USWest2SQS") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSSQS registerSQSWithConfiguration:configuration forKey:@"USWest2SQS"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let SQS = AWSSQS(forKey: "USWest2SQS") - - *Objective-C* - - AWSSQS *SQS = [AWSSQS SQSForKey:@"USWest2SQS"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)SQSForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeSQSForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerSQSWithConfiguration:forKey:` and `+ SQSForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerSQSWithConfiguration:forKey:' and '+ SQSForKey:' instead."))); - -/** -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
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.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
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
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.
Deletes multiple messages. 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.
- - @param request A container for the necessary parameters to execute the DeleteQueue service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. - - @see AWSSQSDeleteQueueRequest - */ -- (BFTask *)deleteQueue:(AWSSQSDeleteQueueRequest *)request; - -/** -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
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.
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.
- - @param request A container for the necessary parameters to execute the ListDeadLetterSourceQueues service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSQSListDeadLetterSourceQueuesResult`. On failed execution, `task.error` may contain an `NSError` with `AWSSQSErrorDomain` domian and the following error code: `AWSSQSErrorQueueDoesNotExist`. - - @see AWSSQSListDeadLetterSourceQueuesRequest - @see AWSSQSListDeadLetterSourceQueuesResult - */ -- (BFTask *)listDeadLetterSourceQueues:(AWSSQSListDeadLetterSourceQueuesRequest *)request; - -/** -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.
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.
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]
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
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.
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 multiple messages. 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 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 form-url-encoded policy. For more information about policy structure, see Basic Policy Structure in the Amazon SQS Developer Guide. For more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.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.
" - }, - "QueueAttributeName":{ - "type":"string", - "enum":[ - "Policy", - "VisibilityTimeout", - "MaximumMessageSize", - "MessageRetentionPeriod", - "ApproximateNumberOfMessages", - "ApproximateNumberOfMessagesNotVisible", - "CreatedTimestamp", - "LastModifiedTimestamp", - "QueueArn", - "ApproximateNumberOfMessagesDelayed", - "DelaySeconds", - "ReceiveMessageWaitTimeSeconds", - "RedrivePolicy" - ] - }, - "QueueDeletedRecently":{ - "type":"structure", - "members":{ - }, - "error":{ - "code":"AWS.SimpleQueueService.QueueDeletedRecently", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"You must wait 60 seconds after deleting a queue before you can create another 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 (epoch time in milliseconds).ApproximateReceiveCount - returns the number of times a message has been received 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 (epoch time in milliseconds).The message attribute Name can contain the following characters: A-Z, a-z, 0-9, underscore(_), hyphen(-), and period (.). The message attribute name must not start or end with a period, and it should not have successive periods. The message attribute name is case sensitive and must be unique among all attribute names for the message. The message attribute name can be up to 256 characters long. Attribute names cannot start with \"AWS.\" or \"Amazon.\" because these prefixes are reserved for use by Amazon Web Services.
" - }, - "MaxNumberOfMessages":{ - "shape":"Integer", - "documentation":"The maximum number of messages to return. Amazon SQS never returns more 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 form-url-encoded policy. For more information about policy structure, see Basic Policy Structure in the Amazon SQS Developer Guide. For more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.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/Frameworks/AWSSimpleDB.framework/AWSSimpleDB b/Frameworks/AWSSimpleDB.framework/AWSSimpleDB deleted file mode 100755 index fcdd193..0000000 Binary files a/Frameworks/AWSSimpleDB.framework/AWSSimpleDB and /dev/null differ diff --git a/Frameworks/AWSSimpleDB.framework/Headers/AWSSimpleDB-umbrella.h b/Frameworks/AWSSimpleDB.framework/Headers/AWSSimpleDB-umbrella.h deleted file mode 100644 index ef64dfc..0000000 --- a/Frameworks/AWSSimpleDB.framework/Headers/AWSSimpleDB-umbrella.h +++ /dev/null @@ -1,9 +0,0 @@ -#importtrue, 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.
- */
-@property (nonatomic, strong) NSNumber *consistentRead;
-
-/**
- The name of the domain in which to perform the operation.
- */
-@property (nonatomic, strong) NSString *domainName;
-
-/**
- The name of the item.
- */
-@property (nonatomic, strong) NSString *itemName;
-
-@end
-
-/**
-
- */
-@interface AWSSimpleDBGetAttributesResult : AWSModel
-
-
-/**
- The list of attributes returned by the operation.
- */
-@property (nonatomic, strong) NSArray *attributes;
-
-@end
-
-/**
-
- Required parameters: [Name, Attributes]
- */
-@interface AWSSimpleDBItem : AWSModel
-
-
-/**
-
- */
-@property (nonatomic, strong) NSString *alternateNameEncoding;
-
-/**
- A list of attributes.
- */
-@property (nonatomic, strong) NSArray *attributes;
-
-/**
- The name of the item.
- */
-@property (nonatomic, strong) NSString *name;
-
-@end
-
-/**
-
- */
-@interface AWSSimpleDBListDomainsRequest : AWSRequest
-
-
-/**
- The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.
- */
-@property (nonatomic, strong) NSNumber *maxNumberOfDomains;
-
-/**
- A string informing Amazon SimpleDB where to start the next list of domain names.
- */
-@property (nonatomic, strong) NSString *nextToken;
-
-@end
-
-/**
-
- */
-@interface AWSSimpleDBListDomainsResult : AWSModel
-
-
-/**
- A list of domain names that match the expression.
- */
-@property (nonatomic, strong) NSArray *domainNames;
-
-/**
- An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.
- */
-@property (nonatomic, strong) NSString *nextToken;
-
-@end
-
-/**
-
- */
-@interface AWSSimpleDBPutAttributesRequest : AWSRequest
-
-
-/**
- The list of attributes.
- */
-@property (nonatomic, strong) NSArray *attributes;
-
-/**
- The name of the domain in which to perform the operation.
- */
-@property (nonatomic, strong) NSString *domainName;
-
-/**
- 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.
- */
-@property (nonatomic, strong) AWSSimpleDBUpdateCondition *expected;
-
-/**
- The name of the item.
- */
-@property (nonatomic, strong) NSString *itemName;
-
-@end
-
-/**
-
- Required parameters: [Name, Value]
- */
-@interface AWSSimpleDBReplaceableAttribute : AWSModel
-
-
-/**
- The name of the replaceable attribute.
- */
-@property (nonatomic, strong) NSString *name;
-
-/**
- A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false.
- */
-@property (nonatomic, strong) NSNumber *replace;
-
-/**
- The value of the replaceable attribute.
- */
-@property (nonatomic, strong) NSString *value;
-
-@end
-
-/**
-
- Required parameters: [Name, Attributes]
- */
-@interface AWSSimpleDBReplaceableItem : AWSModel
-
-
-/**
- The list of attributes for a replaceable item.
- */
-@property (nonatomic, strong) NSArray *attributes;
-
-/**
- The name of the replaceable item.
- */
-@property (nonatomic, strong) NSString *name;
-
-@end
-
-/**
-
- */
-@interface AWSSimpleDBSelectRequest : AWSRequest
-
-
-/**
- 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.
- */
-@property (nonatomic, strong) NSNumber *consistentRead;
-
-/**
- A string informing Amazon SimpleDB where to start the next list of ItemNames.
- */
-@property (nonatomic, strong) NSString *nextToken;
-
-/**
- The expression used to query the domain.
- */
-@property (nonatomic, strong) NSString *selectExpression;
-
-@end
-
-/**
-
- */
-@interface AWSSimpleDBSelectResult : AWSModel
-
-
-/**
- A list of items that match the select expression.
- */
-@property (nonatomic, strong) NSArray *items;
-
-/**
- An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.
- */
-@property (nonatomic, strong) NSString *nextToken;
-
-@end
-
-/**
- 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.
- */ -@interface AWSSimpleDBUpdateCondition : AWSModel - - -/** -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.
The name of the attribute involved in the condition.
- */ -@property (nonatomic, strong) NSString *name; - -/** -The value of an attribute. This value can only be specified when the Exists parameter is equal to true.
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.
- */ -@interface AWSSimpleDB : AWSService - -/** - The service configuration used to instantiate this service client. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - */ -@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration; - -/** - Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) - AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 - credentialsProvider:credentialsProvider]; - [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; - - return YES; - } - - Then call the following to get the default service client: - - *Swift* - - let SimpleDB = AWSSimpleDB.defaultSimpleDB() - - *Objective-C* - - AWSSimpleDB *SimpleDB = [AWSSimpleDB defaultSimpleDB]; - - @return The default service client. - */ -+ (instancetype)defaultSimpleDB; - -/** - Creates a service client with the given service configuration and registers it for the key. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSSimpleDB.registerSimpleDBWithConfiguration(configuration, forKey: "USWest2SimpleDB") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSSimpleDB registerSimpleDBWithConfiguration:configuration forKey:@"USWest2SimpleDB"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let SimpleDB = AWSSimpleDB(forKey: "USWest2SimpleDB") - - *Objective-C* - - AWSSimpleDB *SimpleDB = [AWSSimpleDB SimpleDBForKey:@"USWest2SimpleDB"]; - - @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors. - - @param configuration A service configuration object. - @param key A string to identify the service client. - */ -+ (void)registerSimpleDBWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key; - -/** - Retrieves the service client associated with the key. You need to call `+ registerSimpleDBWithConfiguration:forKey:` before invoking this method. If `+ registerSimpleDBWithConfiguration:forKey:` has not been called in advance or the key does not exist, this method returns `nil`. - - For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:` - - *Swift* - - func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { - let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") - let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) - AWSSimpleDB.registerSimpleDBWithConfiguration(configuration, forKey: "USWest2SimpleDB") - - return true - } - - *Objective-C* - - - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 - identityPoolId:@"YourIdentityPoolId"]; - AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 - credentialsProvider:credentialsProvider]; - - [AWSSimpleDB registerSimpleDBWithConfiguration:configuration forKey:@"USWest2SimpleDB"]; - - return YES; - } - - Then call the following to get the service client: - - *Swift* - - let SimpleDB = AWSSimpleDB(forKey: "USWest2SimpleDB") - - *Objective-C* - - AWSSimpleDB *SimpleDB = [AWSSimpleDB SimpleDBForKey:@"USWest2SimpleDB"]; - - @param key A string to identify the service client. - - @return An instance of the service client. - */ -+ (instancetype)SimpleDBForKey:(NSString *)key; - -/** - Removes the service client associated with the key and release it. - - @warning Before calling this method, make sure no method is running on this client. - - @param key A string to identify the service client. - */ -+ (void)removeSimpleDBForKey:(NSString *)key; - -/** - Instantiates the service client with the given service configuration. - - @warning This method has been deprecated. Use `+ registerSimpleDBWithConfiguration:forKey:` and `+ SimpleDBForKey:` instead. - - @warning Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors. - - @warning Unlike the singleton method, you are responsible for maintaining a strong reference to this object. If the service client is released before completing a service request, the request may fail with unspecified errors. - - @param configuration The service configuration object. - - @return An instance of the service client. - */ -- (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration __attribute__ ((deprecated("Use '+ registerSimpleDBWithConfiguration:forKey:' and '+ SimpleDBForKey:' instead."))); - -/** -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.
If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted.
BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error.
The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses.
This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method.
This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.
The following limitations are enforced for this operation:
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.
BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. 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 operation 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/.
- - @param request A container for the necessary parameters to execute the CreateDomain service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will be `nil`. On failed execution, `task.error` may contain an `NSError` with `AWSSimpleDBErrorDomain` domian and the following error code: `AWSSimpleDBErrorInvalidParameterValue`, `AWSSimpleDBErrorMissingParameter`, `AWSSimpleDBErrorNumberDomainsExceeded`. - - @see AWSSimpleDBCreateDomainRequest - */ -- (BFTask *)createDomain:(AWSSimpleDBCreateDomainRequest *)request; - -/** -Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.
DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are 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 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.
DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. 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.
- - @param request A container for the necessary parameters to execute the DomainMetadata service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSimpleDBDomainMetadataResult`. On failed execution, `task.error` may contain an `NSError` with `AWSSimpleDBErrorDomain` domian and the following error code: `AWSSimpleDBErrorMissingParameter`, `AWSSimpleDBErrorNoSuchDomain`. - - @see AWSSimpleDBDomainMetadataRequest - @see AWSSimpleDBDomainMetadataResult - */ -- (BFTask *)domainMetadata:(AWSSimpleDBDomainMetadataRequest *)request; - -/** -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.
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 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.
PutAttributes to replace attribute values that do not exist will not result in an error response. 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 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.
- - @param request A container for the necessary parameters to execute the Select service method. - - @return An instance of `BFTask`. On successful execution, `task.result` will contain an instance of `AWSSimpleDBSelectResult`. On failed execution, `task.error` may contain an `NSError` with `AWSSimpleDBErrorDomain` domian and the following error code: `AWSSimpleDBErrorInvalidParameterValue`, `AWSSimpleDBErrorInvalidNextToken`, `AWSSimpleDBErrorInvalidNumberPredicates`, `AWSSimpleDBErrorInvalidNumberValueTests`, `AWSSimpleDBErrorInvalidQueryExpression`, `AWSSimpleDBErrorMissingParameter`, `AWSSimpleDBErrorNoSuchDomain`, `AWSSimpleDBErrorRequestTimeout`, `AWSSimpleDBErrorTooManyRequestedAttributes`. - - @see AWSSimpleDBSelectRequest - @see AWSSimpleDBSelectResult - */ -- (BFTask *)select:(AWSSimpleDBSelectRequest *)request; - -@end diff --git a/Frameworks/AWSSimpleDB.framework/Info.plist b/Frameworks/AWSSimpleDB.framework/Info.plist deleted file mode 100644 index 7eaa7e3..0000000 Binary files a/Frameworks/AWSSimpleDB.framework/Info.plist and /dev/null differ diff --git a/Frameworks/AWSSimpleDB.framework/Modules/module.modulemap b/Frameworks/AWSSimpleDB.framework/Modules/module.modulemap deleted file mode 100644 index 6eb82d0..0000000 --- a/Frameworks/AWSSimpleDB.framework/Modules/module.modulemap +++ /dev/null @@ -1,6 +0,0 @@ -framework module AWSSimpleDB { - umbrella header "AWSSimpleDB-umbrella.h" - - export * - module * { export * } -} diff --git a/Frameworks/AWSSimpleDB.framework/_CodeSignature/CodeResources b/Frameworks/AWSSimpleDB.framework/_CodeSignature/CodeResources deleted file mode 100644 index 0abea96..0000000 --- a/Frameworks/AWSSimpleDB.framework/_CodeSignature/CodeResources +++ /dev/null @@ -1,159 +0,0 @@ - - -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.
If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted.
BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error.
The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses.
This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method.
This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.
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.
BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. 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 called without being passed any attributes or values specified, all the attributes for the item are 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.
DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. 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.
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.
PutAttributes to replace attribute values that do not exist will not result in an error response. 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 '.'." - } - } - }, - "DeletableAttribute":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The name of the attribute." - }, - "Value":{ - "shape":"String", - "documentation":"The value of the attribute." - } - }, - "documentation":"" - }, - "DeletableAttributeList":{ - "type":"list", - "member":{ - "shape":"DeletableAttribute", - "locationName":"Attribute" - }, - "flattened":true - }, - "DeletableItem":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"String", - "locationName":"ItemName" - }, - "Attributes":{"shape":"DeletableAttributeList"} - } - }, - "DeletableItemList":{ - "type":"list", - "member":{ - "shape":"DeletableItem", - "locationName":"Item" - }, - "flattened":true - }, - "DeleteAttributesRequest":{ - "type":"structure", - "required":[ - "DomainName", - "ItemName" - ], - "members":{ - "DomainName":{ - "shape":"String", - "documentation":"The name of the domain in which to perform the operation." - }, - "ItemName":{ - "shape":"String", - "documentation":"The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs." - }, - "Attributes":{ - "shape":"DeletableAttributeList", - "documentation":"A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items." - }, - "Expected":{ - "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/Frameworks/Alamofire.framework/Alamofire b/Frameworks/Alamofire.framework/Alamofire index c41daa0..4d1a036 100755 Binary files a/Frameworks/Alamofire.framework/Alamofire and b/Frameworks/Alamofire.framework/Alamofire differ diff --git a/Frameworks/Alamofire.framework/Headers/Alamofire-Swift.h b/Frameworks/Alamofire.framework/Headers/Alamofire-Swift.h index 8cbfc61..43dbbd3 100644 --- a/Frameworks/Alamofire.framework/Headers/Alamofire-Swift.h +++ b/Frameworks/Alamofire.framework/Headers/Alamofire-Swift.h @@ -1,4 +1,4 @@ -// Generated by Apple Swift version 1.2 (swiftlang-602.0.53.1 clang-602.0.53) +// Generated by Apple Swift version 2.1 (swiftlang-700.1.101.6 clang-700.1.76) #pragma clang diagnostic push #if defined(__has_include) && __has_include(SessionDelegate
+/// instance.
+- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+
+/// Overrides default behavior for NSURLSessionDelegate method URLSession:didBecomeInvalidWithError:.
+@property (nonatomic, copy) void (^ __nullable sessionDidBecomeInvalidWithError)(NSURLSession * __nonnull, NSError * __nullable);
+
+/// Overrides default behavior for NSURLSessionDelegate method URLSessionDidFinishEventsForBackgroundURLSession:.
+@property (nonatomic, copy) void (^ __nullable sessionDidFinishEventsForBackgroundURLSession)(NSURLSession * __nonnull);
+
+/// Tells the delegate that the session has been invalidated.
+///
+/// \param session The session object that was invalidated.
+///
+/// \param error The error that caused invalidation, or nil if the invalidation was explicit.
+- (void)URLSession:(NSURLSession * __nonnull)session didBecomeInvalidWithError:(NSError * __nullable)error;
+
+/// Requests credentials from the delegate in response to a session-level authentication request from the remote server.
+///
+/// \param session The session containing the task that requested authentication.
+///
+/// \param challenge An object that contains the request for authentication.
+///
+/// \param completionHandler A handler that your delegate method must call providing the disposition and credential.
+- (void)URLSession:(NSURLSession * __nonnull)session didReceiveChallenge:(NSURLAuthenticationChallenge * __nonnull)challenge completionHandler:(void (^ __nonnull)(NSURLSessionAuthChallengeDisposition, NSURLCredential * __nullable))completionHandler;
+
+/// Tells the delegate that all messages enqueued for a session have been delivered.
+///
+/// \param session The session that no longer has any outstanding requests.
+- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession * __nonnull)session;
+
+/// Overrides default behavior for NSURLSessionTaskDelegate method URLSession:task:willPerformHTTPRedirection:newRequest:completionHandler:.
+@property (nonatomic, copy) NSURLRequest * __nullable (^ __nullable taskWillPerformHTTPRedirection)(NSURLSession * __nonnull, NSURLSessionTask * __nonnull, NSHTTPURLResponse * __nonnull, NSURLRequest * __nonnull);
+
+/// Overrides default behavior for NSURLSessionTaskDelegate method URLSession:session:task:needNewBodyStream:.
+@property (nonatomic, copy) NSInputStream * __null_unspecified (^ __nullable taskNeedNewBodyStream)(NSURLSession * __nonnull, NSURLSessionTask * __nonnull);
+
+/// Overrides default behavior for NSURLSessionTaskDelegate method URLSession:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:.
+@property (nonatomic, copy) void (^ __nullable taskDidSendBodyData)(NSURLSession * __nonnull, NSURLSessionTask * __nonnull, int64_t, int64_t, int64_t);
+
+/// Overrides default behavior for NSURLSessionTaskDelegate method URLSession:task:didCompleteWithError:.
+@property (nonatomic, copy) void (^ __nullable taskDidComplete)(NSURLSession * __nonnull, NSURLSessionTask * __nonnull, NSError * __nullable);
+
+/// Tells the delegate that the remote server requested an HTTP redirect.
+///
+/// \param session The session containing the task whose request resulted in a redirect.
+///
+/// \param task The task whose request resulted in a redirect.
+///
+/// \param response An object containing the server’s response to the original request.
+///
+/// \param request A URL request object filled out with the new location.
+///
+/// \param completionHandler A closure that your handler should call with either the value of the request
+/// parameter, a modified URL request object, or NULL to refuse the redirect and
+/// return the body of the redirect response.
+- (void)URLSession:(NSURLSession * __nonnull)session task:(NSURLSessionTask * __nonnull)task willPerformHTTPRedirection:(NSHTTPURLResponse * __nonnull)response newRequest:(NSURLRequest * __nonnull)request completionHandler:(void (^ __nonnull)(NSURLRequest * __nullable))completionHandler;
+
+/// Requests credentials from the delegate in response to an authentication request from the remote server.
+///
+/// \param session The session containing the task whose request requires authentication.
+///
+/// \param task The task whose request requires authentication.
+///
+/// \param challenge An object that contains the request for authentication.
+///
+/// \param completionHandler A handler that your delegate method must call providing the disposition and credential.
+- (void)URLSession:(NSURLSession * __nonnull)session task:(NSURLSessionTask * __nonnull)task didReceiveChallenge:(NSURLAuthenticationChallenge * __nonnull)challenge completionHandler:(void (^ __nonnull)(NSURLSessionAuthChallengeDisposition, NSURLCredential * __nullable))completionHandler;
+
+/// Tells the delegate when a task requires a new request body stream to send to the remote server.
+///
+/// \param session The session containing the task that needs a new body stream.
+///
+/// \param task The task that needs a new body stream.
+///
+/// \param completionHandler A completion handler that your delegate method should call with the new body stream.
+- (void)URLSession:(NSURLSession * __nonnull)session task:(NSURLSessionTask * __nonnull)task needNewBodyStream:(void (^ __nonnull)(NSInputStream * __nullable))completionHandler;
+
+/// Periodically informs the delegate of the progress of sending body content to the server.
+///
+/// \param session The session containing the data task.
+///
+/// \param task The data task.
+///
+/// \param bytesSent The number of bytes sent since the last time this delegate method was called.
+///
+/// \param totalBytesSent The total number of bytes sent so far.
+///
+/// \param totalBytesExpectedToSend The expected length of the body data.
+- (void)URLSession:(NSURLSession * __nonnull)session task:(NSURLSessionTask * __nonnull)task didSendBodyData:(int64_t)bytesSent totalBytesSent:(int64_t)totalBytesSent totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend;
+
+/// Tells the delegate that the task finished transferring data.
+///
+/// \param session The session containing the task whose request finished transferring data.
+///
+/// \param task The task whose request finished transferring data.
+///
+/// \param error If an error occurred, an error object indicating how the transfer failed, otherwise nil.
+- (void)URLSession:(NSURLSession * __nonnull)session task:(NSURLSessionTask * __nonnull)task didCompleteWithError:(NSError * __nullable)error;
+
+/// Overrides default behavior for NSURLSessionDataDelegate method URLSession:dataTask:didReceiveResponse:completionHandler:.
+@property (nonatomic, copy) NSURLSessionResponseDisposition (^ __nullable dataTaskDidReceiveResponse)(NSURLSession * __nonnull, NSURLSessionDataTask * __nonnull, NSURLResponse * __nonnull);
+
+/// Overrides default behavior for NSURLSessionDataDelegate method URLSession:dataTask:didBecomeDownloadTask:.
+@property (nonatomic, copy) void (^ __nullable dataTaskDidBecomeDownloadTask)(NSURLSession * __nonnull, NSURLSessionDataTask * __nonnull, NSURLSessionDownloadTask * __nonnull);
+
+/// Overrides default behavior for NSURLSessionDataDelegate method URLSession:dataTask:didReceiveData:.
+@property (nonatomic, copy) void (^ __nullable dataTaskDidReceiveData)(NSURLSession * __nonnull, NSURLSessionDataTask * __nonnull, NSData * __nonnull);
+
+/// Overrides default behavior for NSURLSessionDataDelegate method URLSession:dataTask:willCacheResponse:completionHandler:.
+@property (nonatomic, copy) NSCachedURLResponse * __null_unspecified (^ __nullable dataTaskWillCacheResponse)(NSURLSession * __nonnull, NSURLSessionDataTask * __nonnull, NSCachedURLResponse * __nonnull);
+
+/// Tells the delegate that the data task received the initial reply (headers) from the server.
+///
+/// \param session The session containing the data task that received an initial reply.
+///
+/// \param dataTask The data task that received an initial reply.
+///
+/// \param response A URL response object populated with headers.
+///
+/// \param completionHandler A completion handler that your code calls to continue the transfer, passing a
+/// constant to indicate whether the transfer should continue as a data task or
+/// should become a download task.
+- (void)URLSession:(NSURLSession * __nonnull)session dataTask:(NSURLSessionDataTask * __nonnull)dataTask didReceiveResponse:(NSURLResponse * __nonnull)response completionHandler:(void (^ __nonnull)(NSURLSessionResponseDisposition))completionHandler;
+
+/// Tells the delegate that the data task was changed to a download task.
+///
+/// \param session The session containing the task that was replaced by a download task.
+///
+/// \param dataTask The data task that was replaced by a download task.
+///
+/// \param downloadTask The new download task that replaced the data task.
+- (void)URLSession:(NSURLSession * __nonnull)session dataTask:(NSURLSessionDataTask * __nonnull)dataTask didBecomeDownloadTask:(NSURLSessionDownloadTask * __nonnull)downloadTask;
+
+/// Tells the delegate that the data task has received some of the expected data.
+///
+/// \param session The session containing the data task that provided data.
+///
+/// \param dataTask The data task that provided data.
+///
+/// \param data A data object containing the transferred data.
+- (void)URLSession:(NSURLSession * __nonnull)session dataTask:(NSURLSessionDataTask * __nonnull)dataTask didReceiveData:(NSData * __nonnull)data;
+
+/// Asks the delegate whether the data (or upload) task should store the response in the cache.
+///
+/// \param session The session containing the data (or upload) task.
+///
+/// \param dataTask The data (or upload) task.
+///
+/// \param proposedResponse The default caching behavior. This behavior is determined based on the current
+/// caching policy and the values of certain received headers, such as the Pragma
+/// and Cache-Control headers.
+///
+/// \param completionHandler A block that your handler must call, providing either the original proposed
+/// response, a modified version of that response, or NULL to prevent caching the
+/// response. If your delegate implements this method, it must call this completion
+/// handler; otherwise, your app leaks memory.
+- (void)URLSession:(NSURLSession * __nonnull)session dataTask:(NSURLSessionDataTask * __nonnull)dataTask willCacheResponse:(NSCachedURLResponse * __nonnull)proposedResponse completionHandler:(void (^ __nonnull)(NSCachedURLResponse * __nullable))completionHandler;
+
+/// Overrides default behavior for NSURLSessionDownloadDelegate method URLSession:downloadTask:didFinishDownloadingToURL:.
+@property (nonatomic, copy) void (^ __nullable downloadTaskDidFinishDownloadingToURL)(NSURLSession * __nonnull, NSURLSessionDownloadTask * __nonnull, NSURL * __nonnull);
+
+/// Overrides default behavior for NSURLSessionDownloadDelegate method URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:.
+@property (nonatomic, copy) void (^ __nullable downloadTaskDidWriteData)(NSURLSession * __nonnull, NSURLSessionDownloadTask * __nonnull, int64_t, int64_t, int64_t);
+
+/// Overrides default behavior for NSURLSessionDownloadDelegate method URLSession:downloadTask:didResumeAtOffset:expectedTotalBytes:.
+@property (nonatomic, copy) void (^ __nullable downloadTaskDidResumeAtOffset)(NSURLSession * __nonnull, NSURLSessionDownloadTask * __nonnull, int64_t, int64_t);
+
+/// Tells the delegate that a download task has finished downloading.
+///
+/// \param session The session containing the download task that finished.
+///
+/// \param downloadTask The download task that finished.
+///
+/// \param location A file URL for the temporary file. Because the file is temporary, you must either
+/// open the file for reading or move it to a permanent location in your app’s sandbox
+/// container directory before returning from this delegate method.
+- (void)URLSession:(NSURLSession * __nonnull)session downloadTask:(NSURLSessionDownloadTask * __nonnull)downloadTask didFinishDownloadingToURL:(NSURL * __nonnull)location;
+
+/// Periodically informs the delegate about the download’s progress.
+///
+/// \param session The session containing the download task.
+///
+/// \param downloadTask The download task.
+///
+/// \param bytesWritten The number of bytes transferred since the last time this delegate
+/// method was called.
+///
+/// \param totalBytesWritten The total number of bytes transferred so far.
+///
+/// \param totalBytesExpectedToWrite The expected length of the file, as provided by the Content-Length
+/// header. If this header was not provided, the value is
+/// NSURLSessionTransferSizeUnknown
+/// .
+- (void)URLSession:(NSURLSession * __nonnull)session downloadTask:(NSURLSessionDownloadTask * __nonnull)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite;
+
+/// Tells the delegate that the download task has resumed downloading.
+///
+/// \param session The session containing the download task that finished.
+///
+/// \param downloadTask The download task that resumed. See explanation in the discussion.
+///
+/// \param fileOffset If the file's cache policy or last modified date prevents reuse of the
+/// existing content, then this value is zero. Otherwise, this value is an
+/// integer representing the number of bytes on disk that do not need to be
+/// retrieved again.
+///
+/// \param expectedTotalBytes The expected length of the file, as provided by the Content-Length header.
+/// If this header was not provided, the value is NSURLSessionTransferSizeUnknown.
+- (void)URLSession:(NSURLSession * __nonnull)session downloadTask:(NSURLSessionDownloadTask * __nonnull)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes;
+- (BOOL)respondsToSelector:(SEL __null_unspecified)selector;
+@end
+
+@class NSURLSessionStreamTask;
+@class NSOutputStream;
+
+@interface SessionDelegate (SWIFT_EXTENSION(Alamofire))