String requestId
String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorType
String errorMessage
int statusCode
String serviceName
PauseStatus status
String activityId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String description
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String cause
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date startTime
Date endTime
String statusCode
Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, Successful, Failed, Cancelled
String statusMessage
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer progress
String details
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String adjustmentType
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String alarmName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String alarmARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
Date createdTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> suspendedProcesses
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String vPCZoneIdentifier
When
you specify VPCZoneIdentifier
with
AvailabilityZones
, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> enabledMetrics
String status
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleState
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String virtualName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String deviceName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Ebs ebs
Boolean noDevice
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.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceId
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.
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
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
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
String healthCheckType
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.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
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.
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String vPCZoneIdentifier
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 Launch Auto Scaling Instances into Amazon VPC in the Auto Scaling Developer Guide .
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling Developer Guide.
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
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.
String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceId
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.
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
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.
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
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.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean ebsOptimized
Boolean associatePublicIpAddress
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 the platforms supported by Auto Scaling, see Get
Started with Auto Scaling Using the Command Line Interface.
String placementTenancy
dedicated
runs on single-tenant hardware and can only be
launched into a VPC. For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
Valid values: default
|
dedicated
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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.
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean forceDelete
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Integer maxRecords
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingInstances
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingNotificationTypes
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurationNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> granularities
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationConfigurations
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingPolicies
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activityIds
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.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> processes
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledActionNames
Date startTime
Date endTime
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledUpdateGroupActions
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
String snapshotId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer volumeSize
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
.
Constraints:
Range: 1 - 1024
String volumeType
Valid values: standard | io1
Default: standard
Constraints:
Length: 1 - 255
Boolean deleteOnTermination
Default: true
Integer iops
The maximum ratio of IOPS to volume size is 30.0
Valid Values: Range is 100 to 4000.
Default: None.
Constraints:
Range: 100 - 4000
String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean honorCooldown
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.
String name
"auto-scaling-group"
, "key"
,
"value"
, and "propagate-at-launch"
.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String lifecycleState
The Quarantined
lifecycle state is currently not used.
Constraints:
Allowed Values: Pending, Quarantined, InService, Terminating, Terminated
String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean enabled
True
, instance monitoring is enabled.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
String spotPrice
Constraints:
Length: 1 - 255
String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date createdTime
Boolean ebsOptimized
Boolean associatePublicIpAddress
true
) or not (false
).String placementTenancy
default
or dedicated
. An instance with
dedicated
tenancy runs in an isolated, single-tenant
hardware and it can only be launched in a VPC.
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String notificationType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationTypes
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer scalingAdjustment
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.String adjustmentType
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.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer cooldown
For more information, see Cooldown Period
Integer minAdjustmentStep
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
.
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date time
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.
Date startTime
--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.
Date endTime
String recurrence
When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer scalingAdjustment
String adjustmentType
ScalingAdjustment
is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer cooldown
String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarms
Integer minAdjustmentStep
DesiredCapacity
of the Auto Scaling group by
at least the specified number of instances.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String scheduledActionARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Date time
Time
is deprecated. The time that the action is
scheduled to begin. Time
is an alias for
StartTime
.
Date startTime
When StartTime
and
EndTime
are specified with Recurrence
, they
form the boundaries of when the recurring action will start and stop.
Date endTime
String recurrence
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer desiredCapacity
Boolean honorCooldown
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.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String healthStatus
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.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldRespectGracePeriod
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.
String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String suspensionReason
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
To suspend all process types, omit this parameter.
String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String resourceType
auto-scaling-group
resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean propagateAtLaunch
String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String resourceType
auto-scaling-group
resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean propagateAtLaunch
String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Boolean shouldDecrementDesiredCapacity
Activity activity
String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer minSize
Integer maxSize
Integer desiredCapacity
Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
String healthCheckType
EC2
for Amazon EC2 or
ELB
for Elastic Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Integer healthCheckGracePeriod
String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
String vPCZoneIdentifier
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.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
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.
String alarmName
Constraints:
Length: 1 - 255
Date timestamp
String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
String historySummary
Constraints:
Length: 1 - 255
String historyData
Constraints:
Length: 1 - 4095
Date timestamp
Double sampleCount
Double average
Double sum
Double minimum
Double maximum
String unit
Constraints:
Allowed Values: 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
String alarmName
Constraints:
Length: 1 - 255
String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
Date startDate
Date endDate
Integer maxRecords
Constraints:
Range: 1 - 100
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmHistoryItems
String nextToken
String metricName
Constraints:
Length: 1 - 255
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Integer period
Constraints:
Range: 60 -
String unit
Constraints:
Allowed Values: 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
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
String alarmNamePrefix
AlarmNames
cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String actionPrefix
Constraints:
Length: 1 - 1024
Integer maxRecords
Constraints:
Range: 1 - 100
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricAlarms
String nextToken
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Date startTime
Date endTime
Integer period
Period
must be at least 60 seconds and must be a multiple
of 60. The default value is 60.
Constraints:
Range: 60 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> statistics
Constraints:
Length: 1 - 5
String unit
Constraints:
Allowed Values: 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
String label
com.amazonaws.internal.ListWithAutoConstructFlag<T> datapoints
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
String nextToken
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
String alarmName
Constraints:
Length: 1 - 255
String alarmArn
Constraints:
Length: 1 - 1600
String alarmDescription
Constraints:
Length: 0 - 255
Date alarmConfigurationUpdatedTimestamp
Boolean actionsEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> oKActions
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.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmActions
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.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> insufficientDataActions
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.
Constraints:
Length: 0 - 5
String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String stateReason
Constraints:
Length: 0 - 1023
String stateReasonData
Constraints:
Length: 0 - 4000
Date stateUpdatedTimestamp
String metricName
Constraints:
Length: 1 - 255
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Integer period
Constraints:
Range: 60 -
String unit
Constraints:
Allowed Values: 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
Integer evaluationPeriods
Constraints:
Range: 1 -
Double threshold
String comparisonOperator
Statistic
and Threshold
. The specified
Statistic
value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Date timestamp
Double value
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. StatisticSet statisticValues
String unit
Constraints:
Allowed Values: 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
String alarmName
Constraints:
Length: 1 - 255
String alarmDescription
Constraints:
Length: 0 - 255
Boolean actionsEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> oKActions
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.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmActions
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.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> insufficientDataActions
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.
Constraints:
Length: 0 - 5
String metricName
Constraints:
Length: 1 - 255
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
Integer period
Constraints:
Range: 60 -
String unit
Constraints:
Allowed Values: 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
Integer evaluationPeriods
Constraints:
Range: 1 -
Double threshold
String comparisonOperator
Statistic
and Threshold
. The specified
Statistic
value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricData
String alarmName
Constraints:
Length: 1 - 255
String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String stateReason
Constraints:
Length: 0 - 1023
String stateReasonData
Constraints:
Length: 0 - 4000
String s
String n
ByteBuffer b
com.amazonaws.internal.ListWithAutoConstructFlag<T> sS
com.amazonaws.internal.ListWithAutoConstructFlag<T> nS
com.amazonaws.internal.ListWithAutoConstructFlag<T> bS
Map<K,V> m
com.amazonaws.internal.ListWithAutoConstructFlag<T> l
Boolean nULL
Boolean bOOL
AttributeValue value
String action
PUT
, 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 In addition, 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. 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.
Constraints:
Allowed Values: ADD, PUT, DELETE
Map<K,V> requestItems
Each element in the map consists of the following:
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. 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.
Constraints:
Length: 1 - 100
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Map<K,V> responses
Map<K,V> unprocessedKeys
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.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Map<K,V> requestItems
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.
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.
Constraints:
Length: 1 - 25
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, 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.
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> unprocessedItems
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.
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.
Constraints:
Length: 1 - 25
Map<K,V> itemCollectionMetrics
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Double capacityUnits
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
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.
String comparisonOperator
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.
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"]}
.
NE
: Not equal.
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 of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 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 Conditional Expressions in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Double capacityUnits
Capacity table
Map<K,V> localSecondaryIndexes
Map<K,V> globalSecondaryIndexes
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
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.
Constraints:
Length: 1 - 2
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
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.
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
Map<K,V> expected
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 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.
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"]}
.
NE
: Not equal.
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 of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
String conditionalOperator
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.
Constraints:
Allowed Values: AND, OR
String returnValues
NONE
- If ReturnValues is
not specified, or if its value is NONE
, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD
- The content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, 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.
Constraints:
Allowed Values: SIZE, NONE
String conditionExpression
Map<K,V> expressionAttributeNames
Map<K,V> expressionAttributeValues
Map<K,V> attributes
ALL_OLD
in the
request.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
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, measured in gigabytes. 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 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.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
AttributeValue value
Boolean exists
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.)
String comparisonOperator
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.
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"]}
.
NE
: Not equal.
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 of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 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"]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
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.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
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.
Constraints:
Length: 1 -
Boolean consistentRead
true
, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String projectionExpression
Map<K,V> expressionAttributeNames
Map<K,V> item
ConsumedCapacity consumedCapacity
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE
).
Constraints:
Length: 1 - 2
Projection projection
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE
).
Constraints:
Length: 1 - 2
Projection projection
String indexStatus
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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
ProvisionedThroughputDescription provisionedThroughput
Long indexSizeBytes
Long itemCount
UpdateGlobalSecondaryIndexAction update
Map<K,V> itemCollectionKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
Boolean consistentRead
true
, then
a strongly consistent read is used; otherwise, an eventually
consistent read is used.String projectionExpression
Map<K,V> expressionAttributeNames
String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> tableNames
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.
String lastEvaluatedTableName
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE
).
Constraints:
Length: 1 - 2
Projection projection
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or
RANGE
).
Constraints:
Length: 1 - 2
Projection projection
Long indexSizeBytes
Long itemCount
String projectionType
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.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
com.amazonaws.internal.ListWithAutoConstructFlag<T> nonKeyAttributes
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.
Constraints:
Length: 1 - 20
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
Date lastIncreaseDateTime
Date lastDecreaseDateTime
Long numberOfDecreasesToday
Constraints:
Range: 1 -
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> item
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.
Map<K,V> expected
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 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.
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"]}
.
NE
: Not equal.
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 of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
String returnValues
NONE
-
If ReturnValues is not specified, or if its value is
NONE
, then nothing is returned. (This is the default for
ReturnValues.)
ALL_OLD
- If
PutItem overwrote an attribute name-value pair, then the
content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, 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.
Constraints:
Allowed Values: SIZE, NONE
String conditionalOperator
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.
Constraints:
Allowed Values: AND, OR
String conditionExpression
Map<K,V> expressionAttributeNames
Map<K,V> expressionAttributeValues
Map<K,V> attributes
ALL_OLD
in the request. Each element consists of an
attribute name and an attribute value.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
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, measured in gigabytes. 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 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.
Map<K,V> item
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String select
ALL_ATTRIBUTES
: Returns all of
the item attributes from the specified table or index. If you are
querying 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 which have been projected into the
index. If the index is configured to project all attributes, this 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 is equivalent to specifying
AttributesToGet without specifying any value for Select.
If you are querying 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 are querying 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.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
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 are querying 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 are querying 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.
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
Boolean consistentRead
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.
Map<K,V> keyConditions
For a query on a table, you
can only have conditions 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 only have conditions 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.
If you specify more than one condition in the KeyConditions 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 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, etc.
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).
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 of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 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). The target attribute of the comparison must be a String or Binary (not a Number or a set).
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). 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 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 Conditional Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> queryFilter
If you specify more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the 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.
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.
String conditionalOperator
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.
Constraints:
Allowed Values: AND, OR
Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String projectionExpression
String filterExpression
Map<K,V> expressionAttributeNames
Map<K,V> expressionAttributeValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
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.
Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is anything other than null, this 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 null.
ConsumedCapacity consumedCapacity
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
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.
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
String select
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 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 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.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
Map<K,V> scanFilter
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 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.
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.
String conditionalOperator
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.
Constraints:
Allowed Values: AND, OR
Map<K,V> exclusiveStartKey
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.
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Integer totalSegments
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
Integer segment
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 would specify a Segment value of 0, the second thread would specify 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.
Constraints:
Range: 0 - 999999
String projectionExpression
String filterExpression
Map<K,V> expressionAttributeNames
Map<K,V> expressionAttributeValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
If you used a 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.
Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is null, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is anything other than null, this 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 null.
ConsumedCapacity consumedCapacity
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
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.
Constraints:
Length: 1 - 2
String tableStatus
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.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
Long tableSizeBytes
Long itemCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
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.
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
Map<K,V> attributeUpdates
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.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - Specifies how to perform the
update. Valid values for Action are PUT
,
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 In addition, 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. 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.
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.
Map<K,V> expected
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 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.
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"]}
.
NE
: Not equal.
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 of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GE
: Greater than
or equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a 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 compare to {"NS":["6",
"2", "1"]}
.
NOT_NULL
: The
attribute exists.
NULL
: The attribute does
not exist.
CONTAINS
: checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS
: checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH
: checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN
:
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
String conditionalOperator
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.
Constraints:
Allowed Values: AND, OR
String returnValues
NONE
- If ReturnValues is not specified, or if
its value is NONE
, then nothing is returned. (This 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.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
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.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
SIZE
, 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.
Constraints:
Allowed Values: SIZE, NONE
String updateExpression
String conditionExpression
Map<K,V> expressionAttributeNames
Map<K,V> expressionAttributeValues
Map<K,V> attributes
NONE
in the request.
Each element represents one attribute.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexUpdates
TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
String vpcPeeringConnectionId
VpcPeeringConnection vpcPeeringConnection
String attributeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
String attributeValue
String instanceId
String publicIp
String allocationId
String associationId
String domain
standard
) or instances in a VPC
(vpc
).
Constraints:
Allowed Values: vpc, standard
String networkInterfaceId
String networkInterfaceOwnerId
String privateIpAddress
String domain
vpc
to allocate the address for use with instances
in a VPC. Default: The address is for use with instances in EC2-Classic.
Constraints:
Allowed Values: vpc, standard
String publicIp
String domain
standard
) or instances in a VPC
(vpc
).
Constraints:
Allowed Values: vpc, standard
String allocationId
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
Integer secondaryPrivateIpAddressCount
Boolean allowReassignment
String instanceId
String publicIp
String allocationId
String networkInterfaceId
String privateIpAddress
Boolean allowReassociation
Default: false
String associationId
String associationId
String attachmentId
VolumeAttachment attachment
VpcAttachment vpcAttachment
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String zoneName
String state
Constraints:
Allowed Values: available
String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
String message
String virtualName
String deviceName
/dev/sdh
).EbsBlockDevice ebs
String noDevice
String instanceId
Storage storage
BundleTask bundleTask
String instanceId
String bundleId
String state
Constraints:
Allowed Values: pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed
Date startTime
Date updateTime
Storage storage
String progress
BundleTaskError bundleTaskError
String bundleId
BundleTask bundleTask
String exportTaskId
CreateInstanceExportTask
.String reservedInstancesListingId
String ownerId
String conversionTaskId
String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String sourceRegion
String sourceImageId
String name
String description
String clientToken
String imageId
String sourceRegion
String sourceSnapshotId
String description
String destinationRegion
PresignedUrl
.String presignedUrl
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.String snapshotId
String type
Constraints:
Allowed Values: ipsec.1
String publicIp
Integer bgpAsn
Default: 65000
CustomerGateway customerGateway
DhcpOptions dhcpOptions
String instanceId
String name
Constraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes (/), dashes (-), or underscores(_)
String description
Boolean noReboot
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String imageId
String description
String instanceId
String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
String keyName
KeyPair keyPair
String networkAclId
Integer ruleNumber
Constraints: Positive integer from 1 to 32766
String protocol
String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String vpcId
NetworkAcl networkAcl
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
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.
NetworkInterface networkInterface
String reservedInstancesId
Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
String clientToken
String routeTableId
String destinationCidrBlock
String gatewayId
String instanceId
String networkInterfaceId
String vpcPeeringConnectionId
String vpcId
RouteTable routeTable
String groupName
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 ._-:/()#,@[]+=&;{}!$*
String description
String vpcId
String groupId
Snapshot snapshot
SpotDatafeedSubscription spotDatafeedSubscription
Subnet subnet
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
Integer size
Constraints: If the volume type is
io1
, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
String snapshotId
String availabilityZone
String volumeType
gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1
Integer iops
io1
.Boolean encrypted
Volume volume
VpcPeeringConnection vpcPeeringConnection
String cidrBlock
10.0.0.0/16
.String instanceTenancy
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 runs on single-tenant hardware.
Default: default
Constraints:
Allowed Values: default, dedicated
Vpc vpc
String type
String customerGatewayId
String vpnGatewayId
VpnConnectionOptionsSpecification options
true
. Default: false
VpnConnection vpnConnection
VpnGateway vpnGateway
String customerGatewayId
String state
String type
String ipAddress
String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String customerGatewayId
String dhcpOptionsId
String internetGatewayId
String keyName
String networkAclId
String networkInterfaceId
String groupName
String routeTableId
String snapshotId
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
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.String volumeId
String vpcPeeringConnectionId
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.String vpcId
String vpnConnectionId
String vpnGatewayId
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> allocationIds
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> zoneNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
Default: Describes all your bundle tasks.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
Default: Describes all your customer gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
Default: Describes all your DHCP options sets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
Default: Describes all images available to you.
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request), or all
(all owners).com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self
(the sender of the request), or
all
(public AMIs).com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
).
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
InstanceAttribute instanceAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
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
).
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.
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.
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservations
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
event.not-before
- The
earliest start time for the scheduled event.
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
).
String nextToken
Integer maxResults
Default: 1000
Boolean includeAllInstances
true
, includes the health status for all instances.
When false
, includes the health status for running
instances only. Default: false
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStatuses
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
Default: Describes all your Internet gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state
- The
current state of the attachment between the gateway and the VPC.
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
Default: Describes all your key pairs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
fingerprint
- The
fingerprint of the key pair.
key-name
- The
name of the key pair.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
Default: Describes all your network ACLs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
String networkInterfaceId
String description
description
attribute.String sourceDestCheck
sourceDestCheck
attribute.String groups
groupSet
attribute.String attachment
attachment
attribute.String networkInterfaceId
String description
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaceIds
Default: Describes all your network interfaces.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your placement groups, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
).
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
).
String reservedInstancesId
String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModificationIds
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModifications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
String availabilityZone
String productDescription
(Amazon VPC)
in the description are for use with Amazon
VPC.
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
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).
String instanceTenancy
dedicated
tenancy runs on single-tenant hardware and
can only be launched within a VPC. Default: default
Constraints:
Allowed Values: default, dedicated
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
String nextToken
Integer maxResults
Boolean includeMarketplace
Long minDuration
Long maxDuration
Integer maxInstanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferings
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
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.
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).
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Default: Describes all your route tables.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
| CreateRoute
|
EnableVgwRoutePropagation
).
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
String snapshotId
com.amazonaws.internal.ListWithAutoConstructFlag<T> createVolumePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
Default: Describes snapshots for which you have launch permissions.
com.amazonaws.internal.ListWithAutoConstructFlag<T> ownerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableByUserIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
SpotDatafeedSubscription spotDatafeedSubscription
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
launch.network-interface.network-interface-id
- The ID
of the network interface.
launch.network-interface.device-index
- The index of
the device for the network interface attachment on the instance.
launch.network-interface.subnet-id
- The ID of
the subnet for the instance.
launch.network-interface.description
- A description
of the network interface.
launch.network-interface.private-ip-address
- The
primary private IP address of the network interface.
launch.network-interface.delete-on-termination
-
Indicates whether the network interface is deleted when the instance
is terminated.
launch.network-interface.group-id
- The ID of the
security group associated with the network interface.
launch.network-interface.group-name
- The name of the
security group associated with the network interface.
launch.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
).
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.
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> productDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
String availabilityZone
Integer maxResults
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotPriceHistory
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
Default: Describes all your subnets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
Integer maxResults
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
Default: Describes all your volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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
).
String nextToken
Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeStatuses
String nextToken
String vpcId
Boolean enableDnsSupport
true
, the Amazon DNS server resolves DNS
hostnames for your instances to their corresponding IP addresses;
otherwise, it does not.Boolean enableDnsHostnames
true
, instances in the VPC get DNS
hostnames; otherwise, they do not.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Default: Describes all your VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
Default: Describes your VPN connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
Default: Describes all your virtual private gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.
String volumeId
String instanceId
String device
Boolean force
VolumeAttachment attachment
String key
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String associationId
DiskImageDetail image
String description
VolumeDetail volume
String format
Constraints:
Allowed Values: VMDK, RAW, VHD
Long size
String importManifestUrl
String checksum
String format
Constraints:
Allowed Values: VMDK, RAW, VHD
Long bytes
String importManifestUrl
String snapshotId
Integer volumeSize
Constraints: If the volume type is
io1
, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
Boolean deleteOnTermination
String volumeType
Default: standard
Constraints:
Allowed Values: standard, io1
Integer iops
Constraint: Range is 100 to 4000.
Condition: Required
when the volume type is io1
; not used with
standard
or gp2
volumes.
Boolean encrypted
String volumeId
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String volumeId
String exportTaskId
String description
String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
String containerFormat
Constraints:
Allowed Values: ova
String s3Bucket
[email protected]
.String s3Key
String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
String containerFormat
Constraints:
Allowed Values: ova
String s3Bucket
String s3Prefix
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
String instanceId
String instanceId
String imageId
String imageLocation
String state
available
,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: available, deregistered
String ownerId
Boolean publicValue
true
if this image has public launch permissions or
false
if it has only implicit and explicit launch
permissions.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String architecture
Constraints:
Allowed Values: i386, x86_64
String imageType
Constraints:
Allowed Values: machine, kernel, ramdisk
String kernelId
String ramdiskId
String platform
Windows
for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
String sriovNetSupport
StateReason stateReason
String imageOwnerAlias
amazon
,
self
) or the AWS account ID of the AMI owner.String name
String description
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String hypervisor
Constraints:
Allowed Values: ovm, xen
String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String kernelId
String ramdiskId
String description
String sriovNetSupport
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String architecture
Constraints:
Allowed Values: i386, x86_64
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
String additionalInfo
String userData
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
Placement placement
Boolean monitoring
String subnetId
String instanceInitiatedShutdownBehavior
Constraints:
Allowed Values: stop, terminate
String privateIpAddress
String description
ImportInstanceLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskImages
String platform
Constraints:
Allowed Values: Windows
ConversionTask conversionTask
Long bytesConverted
String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
String status
String statusMessage
String description
String availabilityZone
DiskImageDetail image
String description
VolumeDetail volume
ConversionTask conversionTask
Long bytesConverted
String availabilityZone
String description
DiskImageDescription image
DiskImageVolumeDescription volume
String instanceId
String imageId
InstanceState state
String privateDnsName
running
state.String publicDnsName
running
state.String stateTransitionReason
String keyName
Integer amiLaunchIndex
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
Date launchTime
Placement placement
String kernelId
String ramdiskId
String platform
Windows
for Windows instances; otherwise
blank.
Constraints:
Allowed Values: Windows
Monitoring monitoring
String subnetId
String vpcId
String privateIpAddress
String publicIpAddress
StateReason stateReason
String architecture
Constraints:
Allowed Values: i386, x86_64
String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
String instanceLifecycle
Constraints:
Allowed Values: spot
String spotInstanceRequestId
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Boolean sourceDestCheck
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.String hypervisor
Constraints:
Allowed Values: ovm, xen
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
Boolean ebsOptimized
String sriovNetSupport
String instanceId
String instanceType
String kernelId
String ramdiskId
String userData
Boolean disableApiTermination
true
, you can't terminate the instance
through the Amazon EC2 console, CLI, or API; otherwise, you can.String instanceInitiatedShutdownBehavior
String rootDeviceName
/dev/sda1
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
Boolean ebsOptimized
String sriovNetSupport
Boolean sourceDestCheck
String deviceName
EbsInstanceBlockDevice ebs
String deviceName
EbsInstanceBlockDeviceSpecification ebs
String virtualName
String noDevice
String instanceId
Monitoring monitoring
String networkInterfaceId
String subnetId
String vpcId
String description
String ownerId
String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String attachmentId
Integer deviceIndex
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String networkInterfaceId
Integer deviceIndex
String subnetId
String description
String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
Boolean deleteOnTermination
true
, the interface is deleted when the
instance is terminated.com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
Integer secondaryPrivateIpAddressCount
Boolean associatePublicIpAddress
String privateIpAddress
String privateDnsName
Boolean primary
InstanceNetworkInterfaceAssociation association
Integer code
0
:
pending
16
:
running
32
:
shutting-down
48
:
terminated
64
:
stopping
80
:
stopped
String name
Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped
String instanceId
InstanceState currentState
InstanceState previousState
String instanceId
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
InstanceState instanceState
running
state.InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
String name
Constraints:
Allowed Values: reachability
String status
Constraints:
Allowed Values: passed, failed, insufficient-data
Date impairedSince
String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
String description
Date notBefore
Date notAfter
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String internetGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String ipProtocol
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.
Integer fromPort
-1
indicates all ICMP types.Integer toPort
-1
indicates all ICMP codes for the specified
ICMP type.com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
String keyName
String keyFingerprint
String imageId
String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> allSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String userData
String addressingType
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
SpotPlacement placement
String kernelId
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoringEnabled
Default: Disabled
String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default:
false
String imageId
String attribute
String operationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
launchPermission
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
productCodes
attribute.String value
description
attribute.LaunchPermissionModifications launchPermission
String description
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
String value
kernel
,
ramdisk
, userData
,
disableApiTermination
, or
intanceInitiateShutdownBehavior
attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
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.
Boolean sourceDestCheck
true
means that checking is enabled, and
false
means checking is disabled. This value must be
false
for a NAT instance to perform NAT.Boolean disableApiTermination
String instanceType
InvalidInstanceAttributeValue
.String kernel
String ramdisk
String userData
String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
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
.
Boolean ebsOptimized
String sriovNetSupport
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.
String networkInterfaceId
String description
Boolean sourceDestCheck
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachmentChanges attachment
String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> targetConfigurations
String reservedInstancesModificationId
String snapshotId
String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
String operationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
CreateVolumePermissionModifications createVolumePermission
String vpcId
Boolean enableDnsSupport
false
, the Amazon provided DNS service in
the VPC that resolves public DNS hostnames to IP addresses is not
enabled. If this attribute is true
, 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.Boolean enableDnsHostnames
true
, instances in the VPC get DNS
hostnames; otherwise, they do not. You can only set
enableDnsHostnames
to true
if you also set
the EnableDnsSupport
attribute to true
.
String state
Constraints:
Allowed Values: disabled, enabled, pending
String networkAclId
String vpcId
Boolean isDefault
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Integer ruleNumber
String protocol
-1
means all protocols.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String networkInterfaceId
String subnetId
String vpcId
String availabilityZone
String description
String ownerId
String requesterId
Boolean requesterManaged
String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
String macAddress
String privateIpAddress
String privateDnsName
Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String publicIp
String publicDnsName
String ipOwnerId
String allocationId
String associationId
String attachmentId
String instanceId
String instanceOwnerId
Integer deviceIndex
String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
String privateIpAddress
String privateDnsName
Boolean primary
NetworkInterfaceAssociation association
String availabilityZone
String groupName
String tenancy
dedicated
runs on
single-tenant hardware.
Constraints:
Allowed Values: default, dedicated
Long term
Double price
String currencyCode
USD
.
Constraints:
Allowed Values: USD
Boolean active
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.
Long term
Double price
String currencyCode
USD
.
Constraints:
Allowed Values: USD
String gatewayId
String reservedInstancesOfferingId
Integer instanceCount
ReservedInstanceLimitPrice limitPrice
String reservedInstancesId
String imageLocation
String name
Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores (_)
String description
String architecture
Default: For Amazon EBS-backed AMIs,
i386
. For instance store-backed AMIs, the architecture
specified in the manifest file.
Constraints:
Allowed Values: i386, x86_64
String kernelId
String ramdiskId
String rootDeviceName
/dev/sda1
, or
xvda
).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
String virtualizationType
Default: paravirtual
String sriovNetSupport
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.
String imageId
String vpcPeeringConnectionId
Boolean returnValue
true
if the request succeeds; otherwise, it
returns an error.String newAssociationId
String networkAclId
Integer ruleNumber
String protocol
all
or -1
to mean all protocols.String ruleAction
Constraints:
Allowed Values: allow, deny
Boolean egress
Default: If no value is specified, we replace the ingress rule.
String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
String routeTableId
String destinationCidrBlock
String gatewayId
String instanceId
String networkInterfaceId
String vpcPeeringConnectionId
String newAssociationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String status
Constraints:
Allowed Values: ok, impaired
Date startTime
Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> reasonCodes
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]
String description
String spotPrice
Integer instanceCount
Default: 1
String type
Default: one-time
Constraints:
Allowed Values: one-time, persistent
Date validFrom
Default: The request is effective indefinitely.
Date validUntil
Default: The request is effective indefinitely.
String launchGroup
Default: Instances are launched and terminated individually
String availabilityZoneGroup
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.
LaunchSpecification launchSpecification
String reservationId
String ownerId
String requesterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
Double amount
String currencyCode
limitPrice
amount is specified.
At this time, the only supported currency is USD
.
Constraints:
Allowed Values: USD
String reservedInstancesId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
String availabilityZone
Date start
Date end
Long duration
Float usagePrice
Float fixedPrice
Integer instanceCount
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String state
Constraints:
Allowed Values: payment-pending, active, payment-failed, retired
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Constraints:
Allowed Values: default, dedicated
String currencyCode
USD
.
Constraints:
Allowed Values: USD
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
String availabilityZone
String platform
Integer instanceCount
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
String reservedInstancesId
String reservedInstancesListingId
String reservedInstancesId
Date createDate
Date updateDate
String status
Constraints:
Allowed Values: active, pending, cancelled, closed
String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceCounts
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String clientToken
String reservedInstancesModificationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> modificationResults
Date createDate
Date updateDate
Date effectiveDate
String status
String statusMessage
String clientToken
String reservedInstancesId
ReservedInstancesConfiguration targetConfiguration
String reservedInstancesOfferingId
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
String availabilityZone
Long duration
Float usagePrice
Float fixedPrice
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String instanceTenancy
Constraints:
Allowed Values: default, dedicated
String currencyCode
USD
.
Constraints:
Allowed Values: USD
String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
Boolean marketplace
true
.com.amazonaws.internal.ListWithAutoConstructFlag<T> pricingDetails
String instanceId
String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
String networkInterfaceId
String sourceDestCheck
true
means checking is enabled, and false
means checking is disabled. This value must be false
for
a NAT instance to perform NAT.String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String groupName
String groupId
String sourceSecurityGroupName
String sourceSecurityGroupOwnerId
String ipProtocol
Integer fromPort
-1
to specify all
ICMP types.Integer toPort
-1
to specify all
ICMP codes for the ICMP type.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
String destinationCidrBlock
String gatewayId
String instanceId
String instanceOwnerId
String networkInterfaceId
String vpcPeeringConnectionId
String state
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).
Constraints:
Allowed Values: active, blackhole
String origin
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.
Constraints:
Allowed Values: CreateRouteTable, CreateRoute, EnableVgwRoutePropagation
String routeTableId
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> propagatingVgws
String imageId
Integer 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.
Integer maxCount
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.
String keyName
If you launch an instance without specifying a key pair, you can't connect to the instance.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Default: Amazon EC2 uses the default security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Default: Amazon EC2 uses the default security group.
String userData
String instanceType
Default: m1.small
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
Placement placement
String kernelId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB: A New Amazon Kernel Image in the Amazon Elastic Compute Cloud User Guide.
String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
Boolean monitoring
String subnetId
Boolean disableApiTermination
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
String instanceInitiatedShutdownBehavior
Default: stop
Constraints:
Allowed Values: stop, terminate
String privateIpAddress
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.
String clientToken
Constraints: Maximum 64 ASCII characters
String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
Boolean ebsOptimized
Default: false
Reservation reservation
String bucket
String prefix
String aWSAccessKeyId
String uploadPolicy
String uploadPolicySignature
String ownerId
String groupName
String groupId
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissionsEgress
String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String snapshotId
String volumeId
String state
Constraints:
Allowed Values: pending, completed, error
Date startTime
String progress
String ownerId
String description
Integer volumeSize
String ownerAlias
amazon
,
self
) or AWS account ID that owns the snapshot.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Boolean encrypted
String ownerId
String bucket
String prefix
String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
String spotInstanceRequestId
String spotPrice
String type
Constraints:
Allowed Values: one-time, persistent
String state
Constraints:
Allowed Values: open, active, closed, cancelled, failed
SpotInstanceStateFault fault
SpotInstanceStatus status
Date validFrom
Date validUntil
String launchGroup
String availabilityZoneGroup
LaunchSpecification launchSpecification
String instanceId
Date createTime
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String launchedAvailabilityZone
String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
String spotPrice
Date timestamp
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
String additionalInfo
String code
String message
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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Boolean force
Default:
false
S3Storage s3
String subnetId
String state
Constraints:
Allowed Values: pending, available
String vpcId
String cidrBlock
Integer availableIpAddressCount
String availabilityZone
Boolean defaultForAz
Boolean mapPublicIpOnLaunch
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String resourceId
ami-1a2b3c4d
.String resourceType
Constraints:
Allowed Values: 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
String key
String value
String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
String outsideIpAddress
String status
Constraints:
Allowed Values: UP, DOWN
Date lastStatusChange
String statusMessage
Integer acceptedRouteCount
String volumeId
Integer size
String snapshotId
String availabilityZone
String state
Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error
Date createTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String volumeType
gp2
for General Purpose
(SSD) volumes, io1
for Provisioned IOPS (SSD) volumes, or
standard
for Magnetic volumes.
Constraints:
Allowed Values: standard, io1
Integer iops
Boolean encrypted
String volumeId
String instanceId
String device
String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
Date attachTime
Boolean deleteOnTermination
Long size
String status
Constraints:
Allowed Values: ok, impaired, insufficient-data
com.amazonaws.internal.ListWithAutoConstructFlag<T> details
String volumeId
String availabilityZone
VolumeStatusInfo volumeStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
String vpcId
String state
Constraints:
Allowed Values: pending, available
String cidrBlock
String dhcpOptionsId
default
if the default options are associated with the
VPC).com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String instanceTenancy
Constraints:
Allowed Values: default, dedicated
Boolean isDefault
VpcPeeringConnectionVpcInfo accepterVpcInfo
Date expirationTime
VpcPeeringConnectionVpcInfo requesterVpcInfo
VpcPeeringConnectionStateReason status
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String vpcPeeringConnectionId
String vpnConnectionId
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String customerGatewayConfiguration
pending
or available
state.String type
Constraints:
Allowed Values: ipsec.1
String customerGatewayId
String vpnGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> vgwTelemetry
VpnConnectionOptions options
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
Boolean staticRoutesOnly
Boolean staticRoutesOnly
String vpnGatewayId
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
String type
Constraints:
Allowed Values: ipsec.1
String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcAttachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
String destinationCidrBlock
String source
Constraints:
Allowed Values: Static
String state
Constraints:
Allowed Values: pending, available, deleting, deleted
Boolean enabled
String s3BucketName
Integer emitInterval
Default: 60 minutes
String s3BucketPrefix
my-bucket-prefix/prod
. If the prefix is not
provided, the log is placed at the root level of the bucket.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
Integer instancePort
Constraints:
Range: 1 - 65535
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
HealthCheck healthCheck
HealthCheck healthCheck
String loadBalancerName
String policyName
Long cookieExpirationPeriod
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
LoadBalancerPort
, InstancePort
,
Protocol
, and SSLCertificateId
items.String loadBalancerName
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributes
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones.
You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer action.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
String scheme
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more informationabout Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers.
Specify the value
This option is only available for load balancers created within
EC2-VPC. internal
for this option to create an internal load
balancer with a DNS name that resolves to private IP addresses.
String dNSName
Boolean enabled
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerPorts
String loadBalancerName
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerDescriptions
String nextMarker
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
String target
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
Integer interval
Constraints:
Range: 1 - 300
Integer timeout
Constraints:
Range: 1 - 300
Integer unhealthyThreshold
Constraints:
Range: 2 - 10
Integer healthyThreshold
Constraints:
Range: 2 - 10
String instanceId
String instanceId
String state
Valid value:
InService
|OutOfService
String reasonCode
Valid value:
ELB
|Instance
|N/A
String description
String policyName
Long cookieExpirationPeriod
String protocol
Integer loadBalancerPort
String instanceProtocol
InstanceProtocol
has to be at the same
protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end
protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort
whose InstanceProtocol
is
secure, i.e., HTTPS or SSL, the listener's
InstanceProtocol
has to be secure, i.e., HTTPS or SSL. If
there is another listener with the same InstancePort
whose InstanceProtocol
is HTTP or TCP, the listener's
InstanceProtocol
must be either HTTP or TCP. Integer instancePort
Constraints:
Range: 1 - 65535
String sSLCertificateId
Listener listener
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
CrossZoneLoadBalancing crossZoneLoadBalancing
For more information, see Enable Cross-Zone Load Balancing.
AccessLog accessLog
For more information, see Enable Access Logs.
ConnectionDraining connectionDraining
For more information, see Enable Connection Draining.
String loadBalancerName
String dNSName
String canonicalHostedZoneName
String canonicalHostedZoneNameID
com.amazonaws.internal.ListWithAutoConstructFlag<T> listenerDescriptions
Policies policies
com.amazonaws.internal.ListWithAutoConstructFlag<T> backendServerDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
String vPCId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Date createdTime
String scheme
If the Scheme
is
internet-facing
, the load balancer has a publicly
resolvable DNS name that resolves to public IP addresses.
If the
Scheme
is internal
, the load balancer has a
publicly resolvable DNS name that resolves to private IP addresses.
This option is only available for load balancers attached to an Amazon VPC.
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
LoadBalancerAttributes
data type.com.amazonaws.internal.ListWithAutoConstructFlag<T> appCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> otherPolicies
String attributeName
String attributeType
String description
String defaultValue
String cardinality
String policyName
String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeDescriptions
String policyTypeName
String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeTypeDescriptions
String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
String loadBalancerName
Integer loadBalancerPort
String sSLCertificateId
String loadBalancerName
Integer instancePort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String loadBalancerName
Integer loadBalancerPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
String ownerAlias
--source-group-user
parameter of the
ec2-authorize
command in the Amazon EC2 command line
tool.String groupName
--source-group
parameter of the
ec2-authorize
command in the Amazon EC2 command line
tool.String extendedRequestId
Float boxUsage
String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String domainName
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String domainName
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String domainName
String domainName
Integer itemCount
Long itemNamesSizeBytes
Integer attributeNameCount
Long attributeNamesSizeBytes
Integer attributeValueCount
Long attributeValuesSizeBytes
Integer timestamp
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
Boolean consistentRead
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.Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
String nextToken
MaxNumberOfDomains
still available.Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
Float boxUsage
String domainName
String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
String name
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
Float boxUsage
String selectExpression
String nextToken
ItemNames
.Boolean consistentRead
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.com.amazonaws.internal.ListWithAutoConstructFlag<T> items
String nextToken
MaxNumberOfItems
were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.Float boxUsage
String name
String value
Exists
parameter is equal to true
.Boolean exists
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.Content text
Content html
String identity
String emailAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> toAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> bccAddresses
Double max24HourSend
Double maxSendRate
Double sentLast24Hours
Boolean dkimEnabled
String dkimVerificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
String bounceTopic
String complaintTopic
Boolean forwardingEnabled
true
indicates that Amazon SES will forward feedback as
email, while false
indicates that feedback will be
published only to the specified Bounce and Complaint topics.String verificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
String verificationToken
String identityType
Constraints:
Allowed Values: EmailAddress, Domain
String nextToken
Integer maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
String nextToken
ByteBuffer data
For more information, go to the Amazon SES Developer Guide.
Date timestamp
Long deliveryAttempts
Long bounces
Long complaints
Long rejects
String source
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.
Destination destination
Message message
com.amazonaws.internal.ListWithAutoConstructFlag<T> replyToAddresses
String returnPath
ReturnPath
parameter.String messageId
SendEmail
action.String source
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, then bounce
notifications 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> destinations
RawMessage rawMessage
String messageId
SendRawEmail
action.String identity
[email protected]
, example.com
.Boolean forwardingEnabled
true
specifies that Amazon SES will forward feedback
notifications as email, in addition to any Amazon SNS topic publishing
otherwise specified. false
specifies that Amazon SES will
publish feedback notifications only through Amazon SNS. This value can
only be set to false
when topics are specified for both
Bounce
and Complaint
topic types.String identity
[email protected]
, example.com
.String notificationType
Constraints:
Allowed Values: Bounce, Complaint
String snsTopic
String domain
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
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.
String domain
String verificationToken
String emailAddress
String emailAddress
String topicArn
String label
com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actionNames
Valid values: any Amazon SNS action name.
String topicArn
String token
Subscribe
action.String authenticateOnUnsubscribe
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.String subscriptionArn
String name
String platform
Map<K,V> attributes
String platformApplicationArn
String platformApplicationArn
String token
String customUserData
Map<K,V> attributes
String endpointArn
String name
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.
String topicArn
String endpointArn
String platformApplicationArn
String topicArn
String endpointArn
Map<K,V> attributes
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.String platformApplicationArn
Map<K,V> attributes
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.String subscriptionArn
Map<K,V> attributes
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 defaultsString topicArn
Map<K,V> attributes
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 defaultsString platformApplicationArn
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> endpoints
String nextToken
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> platformApplications
String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subscriptions
String nextToken
ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to
retrieve.String nextToken
ListSubscriptions
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> subscriptions
String nextToken
ListSubscriptions
request. This element is returned if there are more subscriptions to
retrieve.String nextToken
ListTopics
request.com.amazonaws.internal.ListWithAutoConstructFlag<T> topics
String nextToken
ListTopics
request. This
element is returned if there are additional topics to retrieve.String dataType
String stringValue
ByteBuffer binaryValue
String topicArn
String targetArn
String message
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).String subject
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.
String messageStructure
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
Map<K,V> messageAttributes
String messageId
Length Constraint: Maximum 100 characters
String endpointArn
Map<K,V> attributes
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.String platformApplicationArn
Map<K,V> attributes
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.String subscriptionArn
String attributeName
Valid values:
DeliveryPolicy
| RawMessageDelivery
String attributeValue
String topicArn
String attributeName
Valid values: Policy
|
DisplayName
| DeliveryPolicy
String attributeValue
String topicArn
String protocol
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.String endpoint
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.String subscriptionArn
String subscriptionArn
String owner
String protocol
String endpoint
String topicArn
String topicArn
String subscriptionArn
String queueUrl
String label
AliceSendMessage
). Constraints: Maximum 80 characters;
alphanumeric characters, hyphens (-), and underscores (_) are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
* | 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
.
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
String id
Id
s of a batch
request need to be unique within the request.String receiptHandle
Integer visibilityTimeout
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String queueUrl
String receiptHandle
Integer visibilityTimeout
String queueName
Map<K,V> attributes
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.String queueUrl
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String queueUrl
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
String queueUrl
String queueUrl
String queueNamePrefix
String messageId
String receiptHandle
String mD5OfBody
String body
Map<K,V> attributes
SenderId
, SentTimestamp
,
ApproximateReceiveCount
, and/or
ApproximateFirstReceiveTimestamp
.
SentTimestamp
and
ApproximateFirstReceiveTimestamp
are each returned as an
integer representing the epoch time in
milliseconds.String mD5OfMessageAttributes
Map<K,V> messageAttributes
String stringValue
ByteBuffer binaryValue
com.amazonaws.internal.ListWithAutoConstructFlag<T> stringListValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> binaryListValues
String dataType
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
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).com.amazonaws.internal.ListWithAutoConstructFlag<T> messageAttributeNames
Integer maxNumberOfMessages
All of the messages are not necessarily returned.
Integer visibilityTimeout
ReceiveMessage
request.Integer waitTimeSeconds
String queueUrl
String label
String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
String id
Id
s of a batch
request need to be unique within the request.String messageBody
Integer delaySeconds
Map<K,V> messageAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
String id
String messageId
String mD5OfMessageBody
String mD5OfMessageAttributes
String queueUrl
String messageBody
Integer delaySeconds
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.Map<K,V> messageAttributes
String mD5OfMessageBody
String mD5OfMessageAttributes
String messageId
String queueUrl
Map<K,V> attributes
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.Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.