|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
| Package com.amazonaws |
|---|
| Class com.amazonaws.AbortedException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.AmazonClientException extends java.lang.RuntimeException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.AmazonServiceException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.String requestId
java.lang.String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorTypejava.lang.String errorMessage
int statusCode
java.lang.String serviceName
| Package com.amazonaws.mobileconnectors.amazonmobileanalytics |
|---|
| Class com.amazonaws.mobileconnectors.amazonmobileanalytics.InitializationException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 2413377589460950524L
| Package com.amazonaws.mobileconnectors.cognito.exceptions |
|---|
| Class com.amazonaws.mobileconnectors.cognito.exceptions.DataAccessNotAuthorizedException extends DataStorageException implements Serializable |
|---|
serialVersionUID: 5067700802587075978L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.DataConflictException extends DataStorageException implements Serializable |
|---|
serialVersionUID: 4937963535057299466L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.DataLimitExceededException extends DataStorageException implements Serializable |
|---|
serialVersionUID: 4722137117318719134L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.DatasetNotFoundException extends DataStorageException implements Serializable |
|---|
serialVersionUID: -5043074429464815354L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.DataStorageException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: -6906342391685175623L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.NetworkException extends DataStorageException implements Serializable |
|---|
serialVersionUID: 8685123233927843893L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.RegistrationFailedException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 5706724903415180392L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.SubscribeFailedException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 5706724903415180392L
| Class com.amazonaws.mobileconnectors.cognito.exceptions.UnsubscribeFailedException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 5706724903415180392L
| Package com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper |
|---|
| Class com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.DynamoDBMappingException extends java.lang.RuntimeException implements Serializable |
|---|
serialVersionUID: -4883173289978517967L
| Package com.amazonaws.mobileconnectors.s3.transfermanager.exception |
|---|
| Class com.amazonaws.mobileconnectors.s3.transfermanager.exception.PauseException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
PauseStatus status
| Package com.amazonaws.services.autoscaling.model |
|---|
| Class com.amazonaws.services.autoscaling.model.Activity extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String activityId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String description
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String cause
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date startTime
java.util.Date endTime
java.lang.String statusCode
Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, Successful, Failed, Cancelled
java.lang.String statusMessage
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer progress
java.lang.String details
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.AdjustmentType extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String adjustmentType
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.Alarm extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String alarmName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String alarmARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.AlreadyExistsException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.autoscaling.model.AttachInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.AutoScalingGroup extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
availabilityZones
Constraints:
Length: 1 -
loadBalancerNames
java.lang.String healthCheckType
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer healthCheckGracePeriod
instances
java.util.Date createdTime
suspendedProcesses
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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]*
enabledMetrics
java.lang.String status
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
tags
terminationPolicies
| Class com.amazonaws.services.autoscaling.model.AutoScalingInstanceDetails extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleState
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.BlockDeviceMapping extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String virtualName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String deviceName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Ebs ebs
java.lang.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.
| Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.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
availabilityZones
Constraints:
Length: 1 -
loadBalancerNames
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
java.lang.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]*
java.lang.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.
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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]*
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.
tags
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling Developer Guide.
| Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\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.
java.lang.String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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]*
java.lang.String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\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.
java.lang.String spotPrice
Constraints:
Length: 1 - 255
java.lang.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]*
java.lang.Boolean ebsOptimized
java.lang.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.
java.lang.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]*
| Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
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.
| Class com.amazonaws.services.autoscaling.model.DeleteAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean forceDelete
| Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DeleteNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
tags
| Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer maxNumberOfAutoScalingGroups
java.lang.Integer maxNumberOfLaunchConfigurations
| Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
adjustmentTypes
| Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
autoScalingGroupNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
| Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
autoScalingGroups
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
java.lang.Integer maxRecords
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
autoScalingInstances
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
autoScalingNotificationTypes
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
| Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
launchConfigurationNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
| Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
launchConfigurations
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
granularities
| Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
autoScalingGroupNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
| Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
notificationConfigurations
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribePoliciesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
policyNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
| Class com.amazonaws.services.autoscaling.model.DescribePoliciesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
scalingPolicies
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
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.
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
activities
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
processes
| Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
scheduledActionNames
java.util.Date startTime
java.util.Date endTime
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
| Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
scheduledUpdateGroupActions
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
filters
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
| Class com.amazonaws.services.autoscaling.model.DescribeTagsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
tags
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
terminationPolicyTypes
OldestInstance, OldestLaunchConfiguration,
NewestInstance, ClosestToNextInstanceHour,
Default
| Class com.amazonaws.services.autoscaling.model.DisableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
| Class com.amazonaws.services.autoscaling.model.Ebs extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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
java.lang.String volumeType
Valid values: standard | io1
Default: standard
Constraints:
Length: 1 - 255
java.lang.Boolean deleteOnTermination
Default: true
java.lang.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
| Class com.amazonaws.services.autoscaling.model.EnabledMetric extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
java.lang.String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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.
| Class com.amazonaws.services.autoscaling.model.Filter extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
"auto-scaling-group", "key",
"value", and "propagate-at-launch".
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
values
| Class com.amazonaws.services.autoscaling.model.Instance extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleState
The Quarantined lifecycle state is currently not used.
Constraints:
Allowed Values: Pending, Quarantined, InService, Terminating, Terminated
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.InstanceMonitoring extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean enabled
True, instance monitoring is enabled.
| Class com.amazonaws.services.autoscaling.model.InvalidNextTokenException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.autoscaling.model.LaunchConfiguration extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
securityGroups
java.lang.String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
blockDeviceMappings
InstanceMonitoring instanceMonitoring
java.lang.String spotPrice
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date createdTime
java.lang.Boolean ebsOptimized
java.lang.Boolean associatePublicIpAddress
true) or not (false).
java.lang.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]*
| Class com.amazonaws.services.autoscaling.model.LimitExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.autoscaling.model.MetricCollectionType extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.MetricGranularityType extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.NotificationConfiguration extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String notificationType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.ProcessType extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
notificationTypes
| Class com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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.
java.lang.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]*
java.lang.Integer cooldown
For more information, see Cooldown Period
java.lang.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.
| Class com.amazonaws.services.autoscaling.model.PutScalingPolicyResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.PutScheduledUpdateGroupActionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.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.
java.util.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.
java.util.Date endTime
java.lang.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]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
| Class com.amazonaws.services.autoscaling.model.ResourceInUseException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.autoscaling.model.ResumeProcessesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
scalingProcesses
To suspend all process types, omit this parameter.
| Class com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.autoscaling.model.ScalingPolicy extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer scalingAdjustment
java.lang.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]*
java.lang.Integer cooldown
java.lang.String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
alarms
java.lang.Integer minAdjustmentStep
DesiredCapacity of the Auto Scaling group by
at least the specified number of instances.
| Class com.amazonaws.services.autoscaling.model.ScheduledUpdateGroupAction extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date time
Time is deprecated. The time that the action is
scheduled to begin. Time is an alias for
StartTime.
java.util.Date startTime
When StartTime and
EndTime are specified with Recurrence, they
form the boundaries of when the recurring action will start and stop.
java.util.Date endTime
java.lang.String recurrence
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
| Class com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer desiredCapacity
java.lang.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.
| Class com.amazonaws.services.autoscaling.model.SetInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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]*
java.lang.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.
| Class com.amazonaws.services.autoscaling.model.SuspendedProcess extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String suspensionReason
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
| Class com.amazonaws.services.autoscaling.model.SuspendProcessesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
scalingProcesses
To suspend all process types, omit this parameter.
| Class com.amazonaws.services.autoscaling.model.Tag extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String resourceType
auto-scaling-group resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean propagateAtLaunch
| Class com.amazonaws.services.autoscaling.model.TagDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String resourceType
auto-scaling-group resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean propagateAtLaunch
| Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
| Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Activity activity
| Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
availabilityZones
Constraints:
Length: 1 -
java.lang.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]*
java.lang.Integer healthCheckGracePeriod
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.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]*
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.
| Package com.amazonaws.services.cloudwatch.model |
|---|
| Class com.amazonaws.services.cloudwatch.model.AlarmHistoryItem extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.util.Date timestamp
java.lang.String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.lang.String historySummary
Constraints:
Length: 1 - 255
java.lang.String historyData
Constraints:
Length: 1 - 4095
| Class com.amazonaws.services.cloudwatch.model.Datapoint extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Date timestamp
java.lang.Double sampleCount
java.lang.Double average
java.lang.Double sum
java.lang.Double minimum
java.lang.Double maximum
java.lang.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
| Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
alarmNames
Constraints:
Length: 0 - 100
| Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.util.Date startDate
java.util.Date endDate
java.lang.Integer maxRecords
Constraints:
Range: 1 - 100
java.lang.String nextToken
| Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
alarmHistoryItems
java.lang.String nextToken
| Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.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
| Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
metricAlarms
| Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
alarmNames
Constraints:
Length: 0 - 100
java.lang.String alarmNamePrefix
AlarmNames cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String actionPrefix
Constraints:
Length: 1 - 1024
java.lang.Integer maxRecords
Constraints:
Range: 1 - 100
java.lang.String nextToken
| Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
metricAlarms
java.lang.String nextToken
| Class com.amazonaws.services.cloudwatch.model.Dimension extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
Constraints:
Length: 1 - 255
java.lang.String value
Constraints:
Length: 1 - 255
| Class com.amazonaws.services.cloudwatch.model.DimensionFilter extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
Constraints:
Length: 1 - 255
java.lang.String value
Name without specifying a Value returns all
values associated with that Name.
Constraints:
Length: 1 - 255
| Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
alarmNames
Constraints:
Length: 0 - 100
| Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
alarmNames
Constraints:
Length: 0 - 100
| Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
dimensions
Constraints:
Length: 0 - 10
java.util.Date startTime
java.util.Date endTime
java.lang.Integer period
Period must be at least 60 seconds and must be a multiple
of 60. The default value is 60.
Constraints:
Range: 60 -
statistics
Constraints:
Length: 1 - 5
java.lang.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
| Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String label
datapoints
| Class com.amazonaws.services.cloudwatch.model.InternalServiceException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.InvalidFormatException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.InvalidNextTokenException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.InvalidParameterValueException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.LimitExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.ListMetricsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
dimensions
Constraints:
Length: 0 - 10
java.lang.String nextToken
| Class com.amazonaws.services.cloudwatch.model.ListMetricsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
metrics
java.lang.String nextToken
| Class com.amazonaws.services.cloudwatch.model.Metric extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
dimensions
Constraints:
Length: 0 - 10
| Class com.amazonaws.services.cloudwatch.model.MetricAlarm extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String alarmArn
Constraints:
Length: 1 - 1600
java.lang.String alarmDescription
Constraints:
Length: 0 - 255
java.util.Date alarmConfigurationUpdatedTimestamp
java.lang.Boolean actionsEnabled
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
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
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
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
Constraints:
Length: 0 - 4000
java.util.Date stateUpdatedTimestamp
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.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
java.lang.Integer evaluationPeriods
Constraints:
Range: 1 -
java.lang.Double threshold
java.lang.String comparisonOperator
Statistic and Threshold. The specified
Statistic value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
| Class com.amazonaws.services.cloudwatch.model.MetricDatum extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String metricName
Constraints:
Length: 1 - 255
dimensions
Constraints:
Length: 0 - 10
java.util.Date timestamp
java.lang.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
java.lang.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
| Class com.amazonaws.services.cloudwatch.model.MissingRequiredParameterException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String alarmDescription
Constraints:
Length: 0 - 255
java.lang.Boolean actionsEnabled
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
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
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
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.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
java.lang.Integer evaluationPeriods
Constraints:
Range: 1 -
java.lang.Double threshold
java.lang.String comparisonOperator
Statistic and Threshold. The specified
Statistic value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
| Class com.amazonaws.services.cloudwatch.model.PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
metricData
| Class com.amazonaws.services.cloudwatch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
Constraints:
Length: 0 - 4000
| Class com.amazonaws.services.cloudwatch.model.StatisticSet extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Double sampleCount
java.lang.Double sum
java.lang.Double minimum
java.lang.Double maximum
| Package com.amazonaws.services.dynamodbv2.datamodeling |
|---|
| Class com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMappingException extends java.lang.RuntimeException implements Serializable |
|---|
serialVersionUID: -4883173289978517967L
| Package com.amazonaws.services.dynamodbv2.model |
|---|
| Class com.amazonaws.services.dynamodbv2.model.AttributeDefinition extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeName
Constraints:
Length: 1 - 255
java.lang.String attributeType
Constraints:
Allowed Values: S, N, B
| Class com.amazonaws.services.dynamodbv2.model.AttributeValue extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String s
java.lang.String n
java.nio.ByteBuffer b
sS
nS
bS
| Class com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
AttributeValue value
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.BatchGetItemResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> responses
java.util.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
consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
| Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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
java.lang.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
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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
java.util.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.
consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
| Class com.amazonaws.services.dynamodbv2.model.Capacity extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Double capacityUnits
| Class com.amazonaws.services.dynamodbv2.model.Condition extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
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.
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.ConsumedCapacity extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Double capacityUnits
Capacity table
java.util.Map<K,V> localSecondaryIndexes
java.util.Map<K,V> globalSecondaryIndexes
| Class com.amazonaws.services.dynamodbv2.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
attributeDefinitions
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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
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.
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.
| Class com.amazonaws.services.dynamodbv2.model.CreateTableResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
TableDescription tableDescription
| Class com.amazonaws.services.dynamodbv2.model.DeleteItemRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
java.util.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.???
java.lang.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
java.lang.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
java.lang.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
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.DeleteItemResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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.
| Class com.amazonaws.services.dynamodbv2.model.DeleteRequest extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> key
| Class com.amazonaws.services.dynamodbv2.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
| Class com.amazonaws.services.dynamodbv2.model.DeleteTableResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
TableDescription tableDescription
| Class com.amazonaws.services.dynamodbv2.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
| Class com.amazonaws.services.dynamodbv2.model.DescribeTableResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
TableDescription table
| Class com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
AttributeValue value
java.lang.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.)
java.lang.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
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.
| Class com.amazonaws.services.dynamodbv2.model.GetItemRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
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 -
java.lang.Boolean consistentRead
true, then the operation uses strongly
consistent reads; otherwise, eventually consistent reads are used.
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.GetItemResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> item
ConsumedCapacity consumedCapacity
| Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndex extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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.
| Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
keySchema
HASH
or RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.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
java.lang.Long indexSizeBytes
java.lang.Long itemCount
| Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexUpdate extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
UpdateGlobalSecondaryIndexAction update
| Class com.amazonaws.services.dynamodbv2.model.InternalServerErrorException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> itemCollectionKey
sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
| Class com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.KeysAndAttributes extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
keys
Constraints:
Length: 1 - 100
attributesToGet
Constraints:
Length: 1 -
java.lang.Boolean consistentRead
true, then
a strongly consistent read is used; otherwise, an eventually
consistent read is used.
| Class com.amazonaws.services.dynamodbv2.model.KeySchemaElement extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeName
Constraints:
Length: 1 - 255
java.lang.String keyType
Constraints:
Allowed Values: HASH, RANGE
| Class com.amazonaws.services.dynamodbv2.model.LimitExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Integer limit
Constraints:
Range: 1 - 100
| Class com.amazonaws.services.dynamodbv2.model.ListTablesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
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.
java.lang.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_.-]+
| Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
keySchema
HASH
or RANGE).
Constraints:
Length: 1 - 2
Projection projection
| Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
keySchema
HASH or
RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.Long indexSizeBytes
java.lang.Long itemCount
| Class com.amazonaws.services.dynamodbv2.model.Projection extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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
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
| Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long readCapacityUnits
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
Constraints:
Range: 1 -
| Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Date lastIncreaseDateTime
java.util.Date lastDecreaseDateTime
java.lang.Long numberOfDecreasesToday
Constraints:
Range: 1 -
java.lang.Long readCapacityUnits
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
Constraints:
Range: 1 -
| Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.PutItemRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.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.
java.util.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.???
java.lang.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
java.lang.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
java.lang.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
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.PutItemResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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.
| Class com.amazonaws.services.dynamodbv2.model.PutRequest extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> item
| Class com.amazonaws.services.dynamodbv2.model.QueryRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.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
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 -
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.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.
java.util.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.
java.util.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.
java.lang.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
java.lang.Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
java.util.Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.QueryResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
items
java.lang.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.
java.lang.Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
java.util.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
| Class com.amazonaws.services.dynamodbv2.model.ResourceInUseException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.dynamodbv2.model.ScanRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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 -
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.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
java.util.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.
java.lang.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
java.util.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.
java.lang.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
java.lang.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
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.ScanResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
items
java.lang.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.
java.lang.Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
java.util.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
| Class com.amazonaws.services.dynamodbv2.model.TableDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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
java.lang.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
java.util.Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
java.lang.Long tableSizeBytes
java.lang.Long itemCount
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.
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.
| Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalSecondaryIndexAction extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
| Class com.amazonaws.services.dynamodbv2.model.UpdateItemRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
java.util.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.
java.util.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.???
java.lang.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
java.lang.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
java.lang.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
java.lang.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
| Class com.amazonaws.services.dynamodbv2.model.UpdateItemResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> attributes
NONE in the request.
Each element represents one attribute.
ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
| Class com.amazonaws.services.dynamodbv2.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
globalSecondaryIndexUpdates
| Class com.amazonaws.services.dynamodbv2.model.UpdateTableResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
TableDescription tableDescription
| Class com.amazonaws.services.dynamodbv2.model.WriteRequest extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
PutRequest putRequest
DeleteRequest deleteRequest
| Package com.amazonaws.services.ec2.model |
|---|
| Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcPeeringConnectionId
| Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VpcPeeringConnection vpcPeeringConnection
| Class com.amazonaws.services.ec2.model.AccountAttribute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeName
attributeValues
| Class com.amazonaws.services.ec2.model.AccountAttributeValue extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeValue
| Class com.amazonaws.services.ec2.model.Address extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String associationId
java.lang.String domain
standard) or instances in a VPC
(vpc).
Constraints:
Allowed Values: vpc, standard
java.lang.String networkInterfaceId
java.lang.String networkInterfaceOwnerId
java.lang.String privateIpAddress
| Class com.amazonaws.services.ec2.model.AllocateAddressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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
| Class com.amazonaws.services.ec2.model.AllocateAddressResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String publicIp
java.lang.String domain
standard) or instances in a VPC
(vpc).
Constraints:
Allowed Values: vpc, standard
java.lang.String allocationId
| Class com.amazonaws.services.ec2.model.AssignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
privateIpAddresses
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean allowReassignment
| Class com.amazonaws.services.ec2.model.AssociateAddressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String networkInterfaceId
java.lang.String privateIpAddress
java.lang.Boolean allowReassociation
Default: false
| Class com.amazonaws.services.ec2.model.AssociateAddressResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String associationId
| Class com.amazonaws.services.ec2.model.AssociateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String dhcpOptionsId
default to associate
no DHCP options with the VPC.
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.AssociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subnetId
java.lang.String routeTableId
| Class com.amazonaws.services.ec2.model.AssociateRouteTableResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String associationId
| Class com.amazonaws.services.ec2.model.AttachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String internetGatewayId
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.String instanceId
java.lang.Integer deviceIndex
| Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attachmentId
| Class com.amazonaws.services.ec2.model.AttachVolumeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
/dev/sdh or xvdh).
| Class com.amazonaws.services.ec2.model.AttachVolumeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VolumeAttachment attachment
| Class com.amazonaws.services.ec2.model.AttachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnGatewayId
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.AttachVpnGatewayResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VpcAttachment vpcAttachment
| Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
tcp, udp,
icmp) or number (see Protocol
Numbers). Use -1 to specify all.
java.lang.Integer fromPort
-1 to specify all
ICMP types.
java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.
java.lang.String cidrIp
ipPermissions
| Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
tcp, udp,
icmp) or number (see Protocol
Numbers). Use -1 to specify all.
java.lang.Integer fromPort
-1 to specify all
ICMP types.
java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.
java.lang.String cidrIp
ipPermissions
| Class com.amazonaws.services.ec2.model.AvailabilityZone extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String zoneName
java.lang.String state
Constraints:
Allowed Values: available
java.lang.String regionName
messages
| Class com.amazonaws.services.ec2.model.AvailabilityZoneMessage extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String message
| Class com.amazonaws.services.ec2.model.BlockDeviceMapping extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String virtualName
java.lang.String deviceName
/dev/sdh).
EbsBlockDevice ebs
java.lang.String noDevice
| Class com.amazonaws.services.ec2.model.BundleInstanceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
Storage storage
| Class com.amazonaws.services.ec2.model.BundleInstanceResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
BundleTask bundleTask
| Class com.amazonaws.services.ec2.model.BundleTask extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String bundleId
java.lang.String state
Constraints:
Allowed Values: pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed
java.util.Date startTime
java.util.Date updateTime
Storage storage
java.lang.String progress
BundleTaskError bundleTaskError
| Class com.amazonaws.services.ec2.model.BundleTaskError extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
java.lang.String message
| Class com.amazonaws.services.ec2.model.CancelBundleTaskRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String bundleId
| Class com.amazonaws.services.ec2.model.CancelBundleTaskResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
BundleTask bundleTask
| Class com.amazonaws.services.ec2.model.CancelConversionTaskRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String conversionTaskId
java.lang.String reasonMessage
| Class com.amazonaws.services.ec2.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String exportTaskId
CreateInstanceExportTask.
| Class com.amazonaws.services.ec2.model.CancelledSpotInstanceRequest extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String spotInstanceRequestId
java.lang.String state
Constraints:
Allowed Values: active, open, closed, cancelled, completed
| Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesListingId
| Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesListings
| Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
spotInstanceRequestIds
| Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
cancelledSpotInstanceRequests
| Class com.amazonaws.services.ec2.model.ConfirmProductInstanceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String productCode
java.lang.String instanceId
| Class com.amazonaws.services.ec2.model.ConfirmProductInstanceResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String ownerId
| Class com.amazonaws.services.ec2.model.ConversionTask extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String conversionTaskId
java.lang.String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
java.lang.String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
java.lang.String statusMessage
tags
| Class com.amazonaws.services.ec2.model.CopyImageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String sourceRegion
java.lang.String sourceImageId
java.lang.String name
java.lang.String description
java.lang.String clientToken
| Class com.amazonaws.services.ec2.model.CopyImageResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
| Class com.amazonaws.services.ec2.model.CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String sourceRegion
java.lang.String sourceSnapshotId
java.lang.String description
java.lang.String destinationRegion
PresignedUrl.
java.lang.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.
| Class com.amazonaws.services.ec2.model.CopySnapshotResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
| Class com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String publicIp
java.lang.Integer bgpAsn
Default: 65000
| Class com.amazonaws.services.ec2.model.CreateCustomerGatewayResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
CustomerGateway customerGateway
| Class com.amazonaws.services.ec2.model.CreateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
dhcpConfigurations
| Class com.amazonaws.services.ec2.model.CreateDhcpOptionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
DhcpOptions dhcpOptions
| Class com.amazonaws.services.ec2.model.CreateImageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String name
Constraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes (/), dashes (-), or underscores(_)
java.lang.String description
java.lang.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.
blockDeviceMappings
| Class com.amazonaws.services.ec2.model.CreateImageResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
| Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String description
java.lang.String instanceId
java.lang.String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
ExportToS3TaskSpecification exportToS3Task
| Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
ExportTask exportTask
| Class com.amazonaws.services.ec2.model.CreateInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.ec2.model.CreateInternetGatewayResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
InternetGateway internetGateway
| Class com.amazonaws.services.ec2.model.CreateKeyPairRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String keyName
| Class com.amazonaws.services.ec2.model.CreateKeyPairResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
KeyPair keyPair
| Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkAclId
java.lang.Integer ruleNumber
Constraints: Positive integer from 1 to 32766
java.lang.String protocol
java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
java.lang.String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
| Class com.amazonaws.services.ec2.model.CreateNetworkAclRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.CreateNetworkAclResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
NetworkAcl networkAcl
| Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
groups
privateIpAddresses
java.lang.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.
| Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
NetworkInterface networkInterface
| Class com.amazonaws.services.ec2.model.CreatePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
Constraints: Up to 255 ASCII characters
java.lang.String strategy
Constraints:
Allowed Values: cluster
| Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesId
java.lang.Integer instanceCount
priceSchedules
java.lang.String clientToken
| Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesListings
| Class com.amazonaws.services.ec2.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
| Class com.amazonaws.services.ec2.model.CreateRouteTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.CreateRouteTableResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
RouteTable routeTable
| Class com.amazonaws.services.ec2.model.CreateSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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 ._-:/()#,@[]+=&;{}!$*
java.lang.String description
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.CreateSecurityGroupResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupId
| Class com.amazonaws.services.ec2.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String description
| Class com.amazonaws.services.ec2.model.CreateSnapshotResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Snapshot snapshot
| Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String bucket
Constraints: Must be a valid bucket associated with your AWS account.
java.lang.String prefix
| Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
SpotDatafeedSubscription spotDatafeedSubscription
| Class com.amazonaws.services.ec2.model.CreateSubnetRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.String cidrBlock
10.0.0.0/24.
java.lang.String availabilityZone
Default: Amazon EC2 selects one for you (recommended).
| Class com.amazonaws.services.ec2.model.CreateSubnetResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Subnet subnet
| Class com.amazonaws.services.ec2.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
resources
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.
| Class com.amazonaws.services.ec2.model.CreateVolumePermission extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String userId
java.lang.String group
Constraints:
Allowed Values: all
| Class com.amazonaws.services.ec2.model.CreateVolumePermissionModifications extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
add
remove
| Class com.amazonaws.services.ec2.model.CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.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
java.lang.Integer iops
io1.
java.lang.Boolean encrypted
| Class com.amazonaws.services.ec2.model.CreateVolumeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Volume volume
| Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.String peerVpcId
java.lang.String peerOwnerId
Default: Your AWS account ID
| Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VpcPeeringConnection vpcPeeringConnection
| Class com.amazonaws.services.ec2.model.CreateVpcRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String cidrBlock
10.0.0.0/16.
java.lang.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
| Class com.amazonaws.services.ec2.model.CreateVpcResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Vpc vpc
| Class com.amazonaws.services.ec2.model.CreateVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String type
java.lang.String customerGatewayId
java.lang.String vpnGatewayId
VpnConnectionOptionsSpecification options
true. Default: false
| Class com.amazonaws.services.ec2.model.CreateVpnConnectionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VpnConnection vpnConnection
| Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnConnectionId
java.lang.String destinationCidrBlock
| Class com.amazonaws.services.ec2.model.CreateVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String availabilityZone
| Class com.amazonaws.services.ec2.model.CreateVpnGatewayResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VpnGateway vpnGateway
| Class com.amazonaws.services.ec2.model.CustomerGateway extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String customerGatewayId
java.lang.String state
java.lang.String type
java.lang.String ipAddress
java.lang.String bgpAsn
tags
| Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String customerGatewayId
| Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String dhcpOptionsId
| Class com.amazonaws.services.ec2.model.DeleteInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String internetGatewayId
| Class com.amazonaws.services.ec2.model.DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String keyName
| Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkAclId
java.lang.Integer ruleNumber
java.lang.Boolean egress
| Class com.amazonaws.services.ec2.model.DeleteNetworkAclRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkAclId
| Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
| Class com.amazonaws.services.ec2.model.DeletePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
| Class com.amazonaws.services.ec2.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
java.lang.String destinationCidrBlock
| Class com.amazonaws.services.ec2.model.DeleteRouteTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
| Class com.amazonaws.services.ec2.model.DeleteSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
java.lang.String groupId
| Class com.amazonaws.services.ec2.model.DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
| Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.ec2.model.DeleteSubnetRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subnetId
| Class com.amazonaws.services.ec2.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
resources
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.
| Class com.amazonaws.services.ec2.model.DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
| Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcPeeringConnectionId
| Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.
| Class com.amazonaws.services.ec2.model.DeleteVpcRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnConnectionId
| Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnConnectionId
java.lang.String destinationCidrBlock
| Class com.amazonaws.services.ec2.model.DeleteVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnGatewayId
| Class com.amazonaws.services.ec2.model.DeregisterImageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
| Class com.amazonaws.services.ec2.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
attributeNames
| Class com.amazonaws.services.ec2.model.DescribeAccountAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
accountAttributes
| Class com.amazonaws.services.ec2.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
publicIps
Default: Describes all your Elastic IP addresses.
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.
allocationIds
Default: Describes all your Elastic IP addresses.
| Class com.amazonaws.services.ec2.model.DescribeAddressesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
addresses
| Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
zoneNames
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).
| Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
availabilityZones
| Class com.amazonaws.services.ec2.model.DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
bundleIds
Default: Describes all your bundle tasks.
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.
| Class com.amazonaws.services.ec2.model.DescribeBundleTasksResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
bundleTasks
| Class com.amazonaws.services.ec2.model.DescribeConversionTasksRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
filters
conversionTaskIds
| Class com.amazonaws.services.ec2.model.DescribeConversionTasksResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
conversionTasks
| Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
customerGatewayIds
Default: Describes all your customer gateways.
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.
| Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
customerGateways
| Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
dhcpOptionsIds
Default: Describes all your DHCP options sets.
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.
| Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
dhcpOptions
| Class com.amazonaws.services.ec2.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
exportTaskIds
| Class com.amazonaws.services.ec2.model.DescribeExportTasksResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
exportTasks
| Class com.amazonaws.services.ec2.model.DescribeImageAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
java.lang.String attribute
Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping
| Class com.amazonaws.services.ec2.model.DescribeImageAttributeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
ImageAttribute imageAttribute
| Class com.amazonaws.services.ec2.model.DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
imageIds
Default: Describes all images available to you.
owners
amazon (owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self (owner is the sender of
the request), or all (all owners).
executableUsers
self (the sender of the request), or
all (public AMIs).
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).
| Class com.amazonaws.services.ec2.model.DescribeImagesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
images
| Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
| Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
InstanceAttribute instanceAttribute
| Class com.amazonaws.services.ec2.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
Default: Describes all your instances.
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.
java.lang.String nextToken
java.lang.Integer maxResults
| Class com.amazonaws.services.ec2.model.DescribeInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservations
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
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).
java.lang.String nextToken
java.lang.Integer maxResults
Default: 1000
java.lang.Boolean includeAllInstances
true, includes the health status for all instances.
When false, includes the health status for running
instances only. Default: false
| Class com.amazonaws.services.ec2.model.DescribeInstanceStatusResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
instanceStatuses
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
internetGatewayIds
Default: Describes all your Internet gateways.
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.
| Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
internetGateways
| Class com.amazonaws.services.ec2.model.DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
keyNames
Default: Describes all your key pairs.
filters
fingerprint - The
fingerprint of the key pair.
key-name - The
name of the key pair.
| Class com.amazonaws.services.ec2.model.DescribeKeyPairsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
keyPairs
| Class com.amazonaws.services.ec2.model.DescribeNetworkAclsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
networkAclIds
Default: Describes all your network ACLs.
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.
| Class com.amazonaws.services.ec2.model.DescribeNetworkAclsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
networkAcls
| Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.String description
description attribute.
java.lang.String sourceDestCheck
sourceDestCheck attribute.
java.lang.String groups
groupSet attribute.
java.lang.String attachment
attachment attribute.
| Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.String description
java.lang.Boolean sourceDestCheck
groups
NetworkInterfaceAttachment attachment
| Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
networkInterfaceIds
Default: Describes all your network interfaces.
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.
| Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
networkInterfaces
| Class com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
groupNames
Default: Describes all your placement groups, or only those otherwise specified.
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).
| Class com.amazonaws.services.ec2.model.DescribePlacementGroupsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
placementGroups
| Class com.amazonaws.services.ec2.model.DescribeRegionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
regionNames
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).
| Class com.amazonaws.services.ec2.model.DescribeRegionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
regions
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesId
java.lang.String reservedInstancesListingId
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.
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesListings
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesModificationIds
java.lang.String nextToken
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.
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesModifications
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesOfferingIds
java.lang.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
java.lang.String availabilityZone
java.lang.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)
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).
java.lang.String instanceTenancy
dedicated tenancy runs on single-tenant hardware and
can only be launched within a VPC. Default: default
Constraints:
Allowed Values: default, dedicated
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
java.lang.String nextToken
java.lang.Integer maxResults
java.lang.Boolean includeMarketplace
java.lang.Long minDuration
java.lang.Long maxDuration
java.lang.Integer maxInstanceCount
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesOfferings
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
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).
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
| Class com.amazonaws.services.ec2.model.DescribeReservedInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
reservedInstances
| Class com.amazonaws.services.ec2.model.DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
routeTableIds
Default: Describes all your route tables.
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.
| Class com.amazonaws.services.ec2.model.DescribeRouteTablesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
routeTables
| Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
groupNames
Default: Describes all your security groups.
groupIds
Default: Describes all your security groups.
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.
| Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
securityGroups
| Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
java.lang.String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
| Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
createVolumePermissions
productCodes
| Class com.amazonaws.services.ec2.model.DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
snapshotIds
Default: Describes snapshots for which you have launch permissions.
ownerIds
restorableByUserIds
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.
| Class com.amazonaws.services.ec2.model.DescribeSnapshotsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
snapshots
| Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
SpotDatafeedSubscription spotDatafeedSubscription
| Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
spotInstanceRequestIds
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.
| Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
spotInstanceRequests
| Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Date startTime
java.util.Date endTime
instanceTypes
productDescriptions
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.
java.lang.String availabilityZone
java.lang.Integer maxResults
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
spotPriceHistory
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
subnetIds
Default: Describes all your subnets.
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.
| Class com.amazonaws.services.ec2.model.DescribeSubnetsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
subnets
| Class com.amazonaws.services.ec2.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
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.
java.lang.Integer maxResults
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeTagsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
tags
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String attribute
Constraints:
Allowed Values: autoEnableIO, productCodes
| Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.Boolean autoEnableIO
autoEnableIO attribute.
productCodes
| Class com.amazonaws.services.ec2.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
volumeIds
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.
| Class com.amazonaws.services.ec2.model.DescribeVolumesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
volumes
| Class com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
volumeIds
Default: Describes all your volumes.
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).
java.lang.String nextToken
java.lang.Integer maxResults
| Class com.amazonaws.services.ec2.model.DescribeVolumeStatusResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
volumeStatuses
java.lang.String nextToken
| Class com.amazonaws.services.ec2.model.DescribeVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.String attribute
Constraints:
Allowed Values: enableDnsSupport, enableDnsHostnames
| Class com.amazonaws.services.ec2.model.DescribeVpcAttributeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.Boolean enableDnsSupport
true, the Amazon DNS server resolves DNS
hostnames for your instances to their corresponding IP addresses;
otherwise, it does not.
java.lang.Boolean enableDnsHostnames
true, instances in the VPC get DNS
hostnames; otherwise, they do not.
| Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
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.
| Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
vpcPeeringConnections
| Class com.amazonaws.services.ec2.model.DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
vpcIds
Default: Describes all your VPCs.
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.
| Class com.amazonaws.services.ec2.model.DescribeVpcsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
vpcs
| Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
vpnConnectionIds
Default: Describes your VPN connections.
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.
| Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
vpnConnections
| Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
vpnGatewayIds
Default: Describes all your virtual private gateways.
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.
| Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
vpnGateways
| Class com.amazonaws.services.ec2.model.DetachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String internetGatewayId
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attachmentId
java.lang.Boolean force
| Class com.amazonaws.services.ec2.model.DetachVolumeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
java.lang.Boolean force
| Class com.amazonaws.services.ec2.model.DetachVolumeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VolumeAttachment attachment
| Class com.amazonaws.services.ec2.model.DetachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnGatewayId
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.DhcpConfiguration extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String key
values
| Class com.amazonaws.services.ec2.model.DhcpOptions extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String dhcpOptionsId
dhcpConfigurations
tags
| Class com.amazonaws.services.ec2.model.DisableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
java.lang.String gatewayId
| Class com.amazonaws.services.ec2.model.DisassociateAddressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String publicIp
java.lang.String associationId
| Class com.amazonaws.services.ec2.model.DisassociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String associationId
| Class com.amazonaws.services.ec2.model.DiskImage extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
DiskImageDetail image
java.lang.String description
VolumeDetail volume
| Class com.amazonaws.services.ec2.model.DiskImageDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String format
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.Long size
java.lang.String importManifestUrl
java.lang.String checksum
| Class com.amazonaws.services.ec2.model.DiskImageDetail extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String format
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.Long bytes
java.lang.String importManifestUrl
| Class com.amazonaws.services.ec2.model.DiskImageVolumeDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long size
java.lang.String id
| Class com.amazonaws.services.ec2.model.EbsBlockDevice extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
java.lang.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.
java.lang.Boolean deleteOnTermination
java.lang.String volumeType
Default: standard
Constraints:
Allowed Values: standard, io1
java.lang.Integer iops
Constraint: Range is 100 to 4000.
Condition: Required
when the volume type is io1; not used with
standard or gp2 volumes.
java.lang.Boolean encrypted
| Class com.amazonaws.services.ec2.model.EbsInstanceBlockDevice extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
| Class com.amazonaws.services.ec2.model.EbsInstanceBlockDeviceSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.Boolean deleteOnTermination
| Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
java.lang.String gatewayId
| Class com.amazonaws.services.ec2.model.EnableVolumeIORequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
| Class com.amazonaws.services.ec2.model.ExportTask extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String exportTaskId
java.lang.String description
java.lang.String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
java.lang.String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
| Class com.amazonaws.services.ec2.model.ExportToS3Task extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.String containerFormat
Constraints:
Allowed Values: ova
java.lang.String s3Bucket
[email protected].
java.lang.String s3Key
| Class com.amazonaws.services.ec2.model.ExportToS3TaskSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.String containerFormat
Constraints:
Allowed Values: ova
java.lang.String s3Bucket
java.lang.String s3Prefix
| Class com.amazonaws.services.ec2.model.Filter extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
values
| Class com.amazonaws.services.ec2.model.GetConsoleOutputRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
| Class com.amazonaws.services.ec2.model.GetConsoleOutputResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.util.Date timestamp
java.lang.String output
| Class com.amazonaws.services.ec2.model.GetPasswordDataRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
| Class com.amazonaws.services.ec2.model.GetPasswordDataResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.util.Date timestamp
java.lang.String passwordData
| Class com.amazonaws.services.ec2.model.GroupIdentifier extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
java.lang.String groupId
| Class com.amazonaws.services.ec2.model.IamInstanceProfile extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String arn
java.lang.String id
| Class com.amazonaws.services.ec2.model.IamInstanceProfileSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String arn
java.lang.String name
| Class com.amazonaws.services.ec2.model.IcmpTypeCode extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer type
java.lang.Integer code
| Class com.amazonaws.services.ec2.model.Image extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
java.lang.String imageLocation
java.lang.String state
available,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: available, deregistered
java.lang.String ownerId
java.lang.Boolean publicValue
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.
productCodes
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
java.lang.String imageType
Constraints:
Allowed Values: machine, kernel, ramdisk
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String platform
Windows for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
java.lang.String sriovNetSupport
StateReason stateReason
java.lang.String imageOwnerAlias
amazon,
self) or the AWS account ID of the AMI owner.
java.lang.String name
java.lang.String description
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String rootDeviceName
blockDeviceMappings
java.lang.String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
tags
java.lang.String hypervisor
Constraints:
Allowed Values: ovm, xen
| Class com.amazonaws.services.ec2.model.ImageAttribute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
launchPermissions
productCodes
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String description
java.lang.String sriovNetSupport
blockDeviceMappings
| Class com.amazonaws.services.ec2.model.ImportInstanceLaunchSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
groupNames
java.lang.String additionalInfo
java.lang.String userData
java.lang.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
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.String instanceInitiatedShutdownBehavior
Constraints:
Allowed Values: stop, terminate
java.lang.String privateIpAddress
| Class com.amazonaws.services.ec2.model.ImportInstanceRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String description
ImportInstanceLaunchSpecification launchSpecification
diskImages
java.lang.String platform
Constraints:
Allowed Values: Windows
| Class com.amazonaws.services.ec2.model.ImportInstanceResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
ConversionTask conversionTask
| Class com.amazonaws.services.ec2.model.ImportInstanceTaskDetails extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
volumes
java.lang.String instanceId
java.lang.String platform
Constraints:
Allowed Values: Windows
java.lang.String description
| Class com.amazonaws.services.ec2.model.ImportInstanceVolumeDetailItem extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long bytesConverted
java.lang.String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String status
java.lang.String statusMessage
java.lang.String description
| Class com.amazonaws.services.ec2.model.ImportKeyPairRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String keyName
java.lang.String publicKeyMaterial
| Class com.amazonaws.services.ec2.model.ImportKeyPairResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String keyName
java.lang.String keyFingerprint
| Class com.amazonaws.services.ec2.model.ImportVolumeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String availabilityZone
DiskImageDetail image
java.lang.String description
VolumeDetail volume
| Class com.amazonaws.services.ec2.model.ImportVolumeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
ConversionTask conversionTask
| Class com.amazonaws.services.ec2.model.ImportVolumeTaskDetails extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long bytesConverted
java.lang.String availabilityZone
java.lang.String description
DiskImageDescription image
DiskImageVolumeDescription volume
| Class com.amazonaws.services.ec2.model.Instance extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String imageId
InstanceState state
java.lang.String privateDnsName
running state.
java.lang.String publicDnsName
running state.
java.lang.String stateTransitionReason
java.lang.String keyName
java.lang.Integer amiLaunchIndex
productCodes
java.lang.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
java.util.Date launchTime
Placement placement
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String platform
Windows for Windows instances; otherwise
blank.
Constraints:
Allowed Values: Windows
Monitoring monitoring
java.lang.String subnetId
java.lang.String vpcId
java.lang.String privateIpAddress
java.lang.String publicIpAddress
StateReason stateReason
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String rootDeviceName
/dev/sda1).
blockDeviceMappings
java.lang.String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
java.lang.String instanceLifecycle
Constraints:
Allowed Values: spot
java.lang.String spotInstanceRequestId
java.lang.String clientToken
tags
securityGroups
java.lang.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.
java.lang.String hypervisor
Constraints:
Allowed Values: ovm, xen
networkInterfaces
IamInstanceProfile iamInstanceProfile
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
| Class com.amazonaws.services.ec2.model.InstanceAttribute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String instanceType
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String userData
java.lang.Boolean disableApiTermination
true, you can't terminate the instance
through the Amazon EC2 console, CLI, or API; otherwise, you can.
java.lang.String instanceInitiatedShutdownBehavior
java.lang.String rootDeviceName
/dev/sda1).
blockDeviceMappings
productCodes
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
java.lang.Boolean sourceDestCheck
| Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String deviceName
EbsInstanceBlockDevice ebs
| Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMappingSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String deviceName
EbsInstanceBlockDeviceSpecification ebs
java.lang.String virtualName
java.lang.String noDevice
| Class com.amazonaws.services.ec2.model.InstanceCount extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String state
Constraints:
Allowed Values: available, sold, cancelled, pending
java.lang.Integer instanceCount
state.
| Class com.amazonaws.services.ec2.model.InstanceExportDetails extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
| Class com.amazonaws.services.ec2.model.InstanceMonitoring extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
Monitoring monitoring
| Class com.amazonaws.services.ec2.model.InstanceNetworkInterface extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.String subnetId
java.lang.String vpcId
java.lang.String description
java.lang.String ownerId
java.lang.String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
privateIpAddresses
| Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAssociation extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String publicIp
java.lang.String publicDnsName
java.lang.String ipOwnerId
| Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAttachment extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attachmentId
java.lang.Integer deviceIndex
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
| Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.Integer deviceIndex
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
groups
java.lang.Boolean deleteOnTermination
true, the interface is deleted when the
instance is terminated.
privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean associatePublicIpAddress
| Class com.amazonaws.services.ec2.model.InstancePrivateIpAddress extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
InstanceNetworkInterfaceAssociation association
| Class com.amazonaws.services.ec2.model.InstanceState extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer code
0 :
pending
16 :
running
32 :
shutting-down
48 :
terminated
64 :
stopping
80 :
stopped
java.lang.String name
Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped
| Class com.amazonaws.services.ec2.model.InstanceStateChange extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
InstanceState currentState
InstanceState previousState
| Class com.amazonaws.services.ec2.model.InstanceStatus extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String availabilityZone
events
InstanceState instanceState
running state.
InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
| Class com.amazonaws.services.ec2.model.InstanceStatusDetails extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
Constraints:
Allowed Values: reachability
java.lang.String status
Constraints:
Allowed Values: passed, failed, insufficient-data
java.util.Date impairedSince
| Class com.amazonaws.services.ec2.model.InstanceStatusEvent extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
java.lang.String description
java.util.Date notBefore
java.util.Date notAfter
| Class com.amazonaws.services.ec2.model.InstanceStatusSummary extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String status
Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable
details
| Class com.amazonaws.services.ec2.model.InternetGateway extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String internetGatewayId
attachments
tags
| Class com.amazonaws.services.ec2.model.InternetGatewayAttachment extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
| Class com.amazonaws.services.ec2.model.IpPermission extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
java.lang.Integer fromPort
-1 indicates all ICMP types.
java.lang.Integer toPort
-1 indicates all ICMP codes for the specified
ICMP type.
userIdGroupPairs
ipRanges
| Class com.amazonaws.services.ec2.model.KeyPair extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String keyName
java.lang.String keyFingerprint
java.lang.String keyMaterial
| Class com.amazonaws.services.ec2.model.KeyPairInfo extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String keyName
java.lang.String keyFingerprint
| Class com.amazonaws.services.ec2.model.LaunchPermission extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String userId
java.lang.String group
Constraints:
Allowed Values: all
| Class com.amazonaws.services.ec2.model.LaunchPermissionModifications extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
add
remove
| Class com.amazonaws.services.ec2.model.LaunchSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
java.lang.String keyName
allSecurityGroups
securityGroups
java.lang.String userData
java.lang.String addressingType
java.lang.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
java.lang.String kernelId
java.lang.String ramdiskId
blockDeviceMappings
java.lang.Boolean monitoringEnabled
Default: Disabled
java.lang.String subnetId
networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default:
false
| Class com.amazonaws.services.ec2.model.ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
java.lang.String attribute
java.lang.String operationType
userIds
launchPermission attribute.
userGroups
launchPermission attribute.
productCodes
productCodes attribute.
java.lang.String value
description attribute.
LaunchPermissionModifications launchPermission
java.lang.String description
| Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
java.lang.String value
kernel,
ramdisk, userData,
disableApiTermination, or
intanceInitiateShutdownBehavior attribute.
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.
java.lang.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.
java.lang.Boolean disableApiTermination
java.lang.String instanceType
InvalidInstanceAttributeValue.
java.lang.String kernel
java.lang.String ramdisk
java.lang.String userData
java.lang.String instanceInitiatedShutdownBehavior
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.
java.lang.Boolean ebsOptimized
java.lang.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.
| Class com.amazonaws.services.ec2.model.ModifyNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.String description
java.lang.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.
groups
NetworkInterfaceAttachmentChanges attachment
| Class com.amazonaws.services.ec2.model.ModifyReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String clientToken
reservedInstancesIds
targetConfigurations
| Class com.amazonaws.services.ec2.model.ModifyReservedInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesModificationId
| Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
java.lang.String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String operationType
userIds
groupNames
CreateVolumePermissionModifications createVolumePermission
| Class com.amazonaws.services.ec2.model.ModifyVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.Boolean autoEnableIO
| Class com.amazonaws.services.ec2.model.ModifyVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.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.
java.lang.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.
| Class com.amazonaws.services.ec2.model.Monitoring extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String state
Constraints:
Allowed Values: disabled, enabled, pending
| Class com.amazonaws.services.ec2.model.MonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
| Class com.amazonaws.services.ec2.model.MonitorInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
instanceMonitorings
| Class com.amazonaws.services.ec2.model.NetworkAcl extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkAclId
java.lang.String vpcId
java.lang.Boolean isDefault
entries
associations
tags
| Class com.amazonaws.services.ec2.model.NetworkAclAssociation extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkAclAssociationId
java.lang.String networkAclId
java.lang.String subnetId
| Class com.amazonaws.services.ec2.model.NetworkAclEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer ruleNumber
java.lang.String protocol
-1 means all protocols.
java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
java.lang.String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
| Class com.amazonaws.services.ec2.model.NetworkInterface extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.String subnetId
java.lang.String vpcId
java.lang.String availabilityZone
java.lang.String description
java.lang.String ownerId
java.lang.String requesterId
java.lang.Boolean requesterManaged
java.lang.String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
java.lang.String macAddress
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
tagSet
privateIpAddresses
| Class com.amazonaws.services.ec2.model.NetworkInterfaceAssociation extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String publicIp
java.lang.String publicDnsName
java.lang.String ipOwnerId
java.lang.String allocationId
java.lang.String associationId
| Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachment extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attachmentId
java.lang.String instanceId
java.lang.String instanceOwnerId
java.lang.Integer deviceIndex
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
| Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachmentChanges extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attachmentId
java.lang.Boolean deleteOnTermination
| Class com.amazonaws.services.ec2.model.NetworkInterfacePrivateIpAddress extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
NetworkInterfaceAssociation association
| Class com.amazonaws.services.ec2.model.Placement extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String availabilityZone
java.lang.String groupName
java.lang.String tenancy
dedicated runs on
single-tenant hardware.
Constraints:
Allowed Values: default, dedicated
| Class com.amazonaws.services.ec2.model.PlacementGroup extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
java.lang.String strategy
Constraints:
Allowed Values: cluster
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
| Class com.amazonaws.services.ec2.model.PortRange extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer from
java.lang.Integer to
| Class com.amazonaws.services.ec2.model.PriceSchedule extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long term
java.lang.Double price
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.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.
| Class com.amazonaws.services.ec2.model.PriceScheduleSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long term
java.lang.Double price
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
| Class com.amazonaws.services.ec2.model.PricingDetail extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Double price
java.lang.Integer count
| Class com.amazonaws.services.ec2.model.PrivateIpAddressSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String privateIpAddress
java.lang.Boolean primary
| Class com.amazonaws.services.ec2.model.ProductCode extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String productCodeId
java.lang.String productCodeType
Constraints:
Allowed Values: devpay, marketplace
| Class com.amazonaws.services.ec2.model.PropagatingVgw extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String gatewayId
| Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesOfferingId
java.lang.Integer instanceCount
ReservedInstanceLimitPrice limitPrice
| Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesId
| Class com.amazonaws.services.ec2.model.RebootInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
| Class com.amazonaws.services.ec2.model.RecurringCharge extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String frequency
Constraints:
Allowed Values: Hourly
java.lang.Double amount
| Class com.amazonaws.services.ec2.model.Region extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String regionName
java.lang.String endpoint
| Class com.amazonaws.services.ec2.model.RegisterImageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageLocation
java.lang.String name
Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores (_)
java.lang.String description
java.lang.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
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String rootDeviceName
/dev/sda1, or
xvda).
blockDeviceMappings
java.lang.String virtualizationType
Default: paravirtual
java.lang.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.
| Class com.amazonaws.services.ec2.model.RegisterImageResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
| Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcPeeringConnectionId
| Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean returnValue
true if the request succeeds; otherwise, it
returns an error.
| Class com.amazonaws.services.ec2.model.ReleaseAddressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String publicIp
java.lang.String allocationId
| Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String associationId
java.lang.String networkAclId
| Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String newAssociationId
| Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkAclId
java.lang.Integer ruleNumber
java.lang.String protocol
all or -1
to mean all protocols.
java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
Default: If no value is specified, we replace the ingress rule.
java.lang.String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
| Class com.amazonaws.services.ec2.model.ReplaceRouteRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
| Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String associationId
java.lang.String routeTableId
| Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String newAssociationId
| Class com.amazonaws.services.ec2.model.ReportInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instances
java.lang.String status
Constraints:
Allowed Values: ok, impaired
java.util.Date startTime
java.util.Date endTime
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]
java.lang.String description
| Class com.amazonaws.services.ec2.model.RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String spotPrice
java.lang.Integer instanceCount
Default: 1
java.lang.String type
Default: one-time
Constraints:
Allowed Values: one-time, persistent
java.util.Date validFrom
Default: The request is effective indefinitely.
java.util.Date validUntil
Default: The request is effective indefinitely.
java.lang.String launchGroup
Default: Instances are launched and terminated individually
java.lang.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
| Class com.amazonaws.services.ec2.model.RequestSpotInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
spotInstanceRequests
| Class com.amazonaws.services.ec2.model.Reservation extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservationId
java.lang.String ownerId
java.lang.String requesterId
groups
groupNames
instances
| Class com.amazonaws.services.ec2.model.ReservedInstanceLimitPrice extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Double amount
java.lang.String currencyCode
limitPrice amount is specified.
At this time, the only supported currency is USD.
Constraints:
Allowed Values: USD
| Class com.amazonaws.services.ec2.model.ReservedInstances extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesId
java.lang.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
java.lang.String availabilityZone
java.util.Date start
java.util.Date end
java.lang.Long duration
java.lang.Float usagePrice
java.lang.Float fixedPrice
java.lang.Integer instanceCount
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
java.lang.String state
Constraints:
Allowed Values: payment-pending, active, payment-failed, retired
tags
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
recurringCharges
| Class com.amazonaws.services.ec2.model.ReservedInstancesConfiguration extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String availabilityZone
java.lang.String platform
java.lang.Integer instanceCount
java.lang.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
| Class com.amazonaws.services.ec2.model.ReservedInstancesId extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesId
| Class com.amazonaws.services.ec2.model.ReservedInstancesListing extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesListingId
java.lang.String reservedInstancesId
java.util.Date createDate
java.util.Date updateDate
java.lang.String status
Constraints:
Allowed Values: active, pending, cancelled, closed
java.lang.String statusMessage
instanceCounts
priceSchedules
tags
java.lang.String clientToken
| Class com.amazonaws.services.ec2.model.ReservedInstancesModification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesModificationId
reservedInstancesIds
modificationResults
java.util.Date createDate
java.util.Date updateDate
java.util.Date effectiveDate
java.lang.String status
java.lang.String statusMessage
java.lang.String clientToken
| Class com.amazonaws.services.ec2.model.ReservedInstancesModificationResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesId
ReservedInstancesConfiguration targetConfiguration
| Class com.amazonaws.services.ec2.model.ReservedInstancesOffering extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String reservedInstancesOfferingId
java.lang.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
java.lang.String availabilityZone
java.lang.Long duration
java.lang.Float usagePrice
java.lang.Float fixedPrice
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
recurringCharges
java.lang.Boolean marketplace
true.
pricingDetails
| Class com.amazonaws.services.ec2.model.ResetImageAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
java.lang.String attribute
Constraints:
Allowed Values: launchPermission
| Class com.amazonaws.services.ec2.model.ResetInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
| Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
java.lang.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.
| Class com.amazonaws.services.ec2.model.ResetSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
java.lang.String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
| Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
tcp, udp,
icmp) or number (see Protocol
Numbers). Use -1 to specify all.
java.lang.Integer fromPort
-1 to specify all
ICMP types.
java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.
java.lang.String cidrIp
ipPermissions
| Class com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
tcp, udp,
icmp) or number (see Protocol
Numbers). Use -1 to specify all.
java.lang.Integer fromPort
-1 to specify all
ICMP types.
java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.
java.lang.String cidrIp
ipPermissions
| Class com.amazonaws.services.ec2.model.Route extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String instanceOwnerId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
java.lang.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
java.lang.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
| Class com.amazonaws.services.ec2.model.RouteTable extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableId
java.lang.String vpcId
routes
associations
tags
propagatingVgws
| Class com.amazonaws.services.ec2.model.RouteTableAssociation extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String routeTableAssociationId
java.lang.String routeTableId
java.lang.String subnetId
java.lang.Boolean main
| Class com.amazonaws.services.ec2.model.RunInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String imageId
java.lang.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.
java.lang.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.
java.lang.String keyName
If you launch an instance without specifying a key pair, you can't connect to the instance.
securityGroups
Default: Amazon EC2 uses the default security group.
securityGroupIds
Default: Amazon EC2 uses the default security group.
java.lang.String userData
java.lang.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
java.lang.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.
java.lang.String ramdiskId
blockDeviceMappings
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.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
java.lang.String instanceInitiatedShutdownBehavior
Default: stop
Constraints:
Allowed Values: stop, terminate
java.lang.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.
java.lang.String clientToken
Constraints: Maximum 64 ASCII characters
java.lang.String additionalInfo
networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default: false
| Class com.amazonaws.services.ec2.model.RunInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Reservation reservation
| Class com.amazonaws.services.ec2.model.S3Storage extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String bucket
java.lang.String prefix
java.lang.String aWSAccessKeyId
java.lang.String uploadPolicy
java.lang.String uploadPolicySignature
| Class com.amazonaws.services.ec2.model.SecurityGroup extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String ownerId
java.lang.String groupName
java.lang.String groupId
java.lang.String description
ipPermissions
ipPermissionsEgress
java.lang.String vpcId
tags
| Class com.amazonaws.services.ec2.model.Snapshot extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String snapshotId
java.lang.String volumeId
java.lang.String state
Constraints:
Allowed Values: pending, completed, error
java.util.Date startTime
java.lang.String progress
java.lang.String ownerId
java.lang.String description
java.lang.Integer volumeSize
java.lang.String ownerAlias
amazon,
self) or AWS account ID that owns the snapshot.
tags
java.lang.Boolean encrypted
| Class com.amazonaws.services.ec2.model.SpotDatafeedSubscription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String ownerId
java.lang.String bucket
java.lang.String prefix
java.lang.String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
| Class com.amazonaws.services.ec2.model.SpotInstanceRequest extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String spotInstanceRequestId
java.lang.String spotPrice
java.lang.String type
Constraints:
Allowed Values: one-time, persistent
java.lang.String state
Constraints:
Allowed Values: open, active, closed, cancelled, failed
SpotInstanceStateFault fault
SpotInstanceStatus status
java.util.Date validFrom
java.util.Date validUntil
java.lang.String launchGroup
java.lang.String availabilityZoneGroup
LaunchSpecification launchSpecification
java.lang.String instanceId
java.util.Date createTime
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
tags
java.lang.String launchedAvailabilityZone
| Class com.amazonaws.services.ec2.model.SpotInstanceStateFault extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
java.lang.String message
| Class com.amazonaws.services.ec2.model.SpotInstanceStatus extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
java.util.Date updateTime
java.lang.String message
| Class com.amazonaws.services.ec2.model.SpotPlacement extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String availabilityZone
java.lang.String groupName
| Class com.amazonaws.services.ec2.model.SpotPrice extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
java.lang.String spotPrice
java.util.Date timestamp
java.lang.String availabilityZone
| Class com.amazonaws.services.ec2.model.StartInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
java.lang.String additionalInfo
| Class com.amazonaws.services.ec2.model.StartInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
startingInstances
| Class com.amazonaws.services.ec2.model.StateReason extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
java.lang.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.
| Class com.amazonaws.services.ec2.model.StopInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
java.lang.Boolean force
Default:
false
| Class com.amazonaws.services.ec2.model.StopInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
stoppingInstances
| Class com.amazonaws.services.ec2.model.Storage extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
S3Storage s3
| Class com.amazonaws.services.ec2.model.Subnet extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subnetId
java.lang.String state
Constraints:
Allowed Values: pending, available
java.lang.String vpcId
java.lang.String cidrBlock
java.lang.Integer availableIpAddressCount
java.lang.String availabilityZone
java.lang.Boolean defaultForAz
java.lang.Boolean mapPublicIpOnLaunch
tags
| Class com.amazonaws.services.ec2.model.Tag extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String key
Constraints: Tag keys are case-sensitive and
accept a maximum of 127 Unicode characters. May not begin with
aws:
java.lang.String value
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
| Class com.amazonaws.services.ec2.model.TagDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String resourceId
ami-1a2b3c4d.
java.lang.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
java.lang.String key
java.lang.String value
| Class com.amazonaws.services.ec2.model.TerminateInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
| Class com.amazonaws.services.ec2.model.TerminateInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
terminatingInstances
| Class com.amazonaws.services.ec2.model.UnassignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String networkInterfaceId
privateIpAddresses
| Class com.amazonaws.services.ec2.model.UnmonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
instanceIds
| Class com.amazonaws.services.ec2.model.UnmonitorInstancesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
instanceMonitorings
| Class com.amazonaws.services.ec2.model.UserIdGroupPair extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String userId
java.lang.String groupName
java.lang.String groupId
| Class com.amazonaws.services.ec2.model.VgwTelemetry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String outsideIpAddress
java.lang.String status
Constraints:
Allowed Values: UP, DOWN
java.util.Date lastStatusChange
java.lang.String statusMessage
java.lang.Integer acceptedRouteCount
| Class com.amazonaws.services.ec2.model.Volume extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.Integer size
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.String state
Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error
java.util.Date createTime
attachments
tags
java.lang.String volumeType
gp2 for General Purpose
(SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes.
Constraints:
Allowed Values: standard, io1
java.lang.Integer iops
java.lang.Boolean encrypted
| Class com.amazonaws.services.ec2.model.VolumeAttachment extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
| Class com.amazonaws.services.ec2.model.VolumeDetail extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Long size
| Class com.amazonaws.services.ec2.model.VolumeStatusAction extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
enable-volume-io.
java.lang.String description
java.lang.String eventType
java.lang.String eventId
| Class com.amazonaws.services.ec2.model.VolumeStatusDetails extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
Constraints:
Allowed Values: io-enabled, io-performance
java.lang.String status
| Class com.amazonaws.services.ec2.model.VolumeStatusEvent extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String eventType
java.lang.String description
java.util.Date notBefore
java.util.Date notAfter
java.lang.String eventId
| Class com.amazonaws.services.ec2.model.VolumeStatusInfo extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String status
Constraints:
Allowed Values: ok, impaired, insufficient-data
details
| Class com.amazonaws.services.ec2.model.VolumeStatusItem extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String volumeId
java.lang.String availabilityZone
VolumeStatusInfo volumeStatus
events
actions
| Class com.amazonaws.services.ec2.model.Vpc extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.String state
Constraints:
Allowed Values: pending, available
java.lang.String cidrBlock
java.lang.String dhcpOptionsId
default if the default options are associated with the
VPC).
tags
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated
java.lang.Boolean isDefault
| Class com.amazonaws.services.ec2.model.VpcAttachment extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpcId
java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
| Class com.amazonaws.services.ec2.model.VpcPeeringConnection extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
VpcPeeringConnectionVpcInfo accepterVpcInfo
java.util.Date expirationTime
VpcPeeringConnectionVpcInfo requesterVpcInfo
VpcPeeringConnectionStateReason status
tags
java.lang.String vpcPeeringConnectionId
| Class com.amazonaws.services.ec2.model.VpcPeeringConnectionStateReason extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String code
java.lang.String message
| Class com.amazonaws.services.ec2.model.VpcPeeringConnectionVpcInfo extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String cidrBlock
java.lang.String ownerId
java.lang.String vpcId
| Class com.amazonaws.services.ec2.model.VpnConnection extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnConnectionId
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.String customerGatewayConfiguration
pending or available state.
java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String customerGatewayId
java.lang.String vpnGatewayId
tags
vgwTelemetry
VpnConnectionOptions options
routes
| Class com.amazonaws.services.ec2.model.VpnConnectionOptions extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean staticRoutesOnly
| Class com.amazonaws.services.ec2.model.VpnConnectionOptionsSpecification extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean staticRoutesOnly
| Class com.amazonaws.services.ec2.model.VpnGateway extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String vpnGatewayId
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String availabilityZone
vpcAttachments
tags
| Class com.amazonaws.services.ec2.model.VpnStaticRoute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String destinationCidrBlock
java.lang.String source
Constraints:
Allowed Values: Static
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
| Package com.amazonaws.services.elasticloadbalancing.model |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.AccessLog extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean enabled
java.lang.String s3BucketName
java.lang.Integer emitInterval
Default: 60 minutes
java.lang.String s3BucketPrefix
my-bucket-prefix/prod. If the prefix is not
provided, the log is placed at the root level of the bucket.
| Class com.amazonaws.services.elasticloadbalancing.model.AppCookieStickinessPolicy extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String policyName
java.lang.String cookieName
| Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
securityGroups
| Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
securityGroups
| Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
subnets
| Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
subnets
| Class com.amazonaws.services.elasticloadbalancing.model.BackendServerDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer instancePort
Constraints:
Range: 1 - 65535
policyNames
| Class com.amazonaws.services.elasticloadbalancing.model.CertificateNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
HealthCheck healthCheck
| Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
HealthCheck healthCheck
| Class com.amazonaws.services.elasticloadbalancing.model.ConnectionDraining extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean enabled
java.lang.Integer timeout
| Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.String cookieName
| Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.Long cookieExpirationPeriod
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
listeners
LoadBalancerPort, InstancePort,
Protocol, and SSLCertificateId items.
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.String policyTypeName
policyAttributes
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
listeners
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.
subnets
securityGroups
java.lang.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.
| Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String dNSName
| Class com.amazonaws.services.elasticloadbalancing.model.CrossZoneLoadBalancing extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean enabled
| Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
loadBalancerPorts
| Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.String policyName
| Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
| Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
instances
| Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
instances
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
instances
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
instanceStates
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
LoadBalancerAttributes loadBalancerAttributes
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
policyNames
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
policyDescriptions
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
policyTypeNames
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
policyTypeDescriptions
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
loadBalancerNames
java.lang.String marker
| Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
loadBalancerDescriptions
java.lang.String nextMarker
| Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
subnets
| Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
subnets
| Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
availabilityZones
| Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
availabilityZones
| Class com.amazonaws.services.elasticloadbalancing.model.DuplicateListenerException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.DuplicateLoadBalancerNameException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.DuplicatePolicyNameException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
availabilityZones
| Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
availabilityZones
| Class com.amazonaws.services.elasticloadbalancing.model.HealthCheck extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
java.lang.Integer interval
Constraints:
Range: 1 - 300
java.lang.Integer timeout
Constraints:
Range: 1 - 300
java.lang.Integer unhealthyThreshold
Constraints:
Range: 2 - 10
java.lang.Integer healthyThreshold
Constraints:
Range: 2 - 10
| Class com.amazonaws.services.elasticloadbalancing.model.Instance extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
| Class com.amazonaws.services.elasticloadbalancing.model.InstanceState extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String instanceId
java.lang.String state
Valid value:
InService|OutOfService
java.lang.String reasonCode
Valid value:
ELB|Instance|N/A
java.lang.String description
| Class com.amazonaws.services.elasticloadbalancing.model.InvalidConfigurationRequestException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.InvalidInstanceException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.InvalidSchemeException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.InvalidSecurityGroupException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.InvalidSubnetException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.LBCookieStickinessPolicy extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String policyName
java.lang.Long cookieExpirationPeriod
| Class com.amazonaws.services.elasticloadbalancing.model.Listener extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String protocol
java.lang.Integer loadBalancerPort
java.lang.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.
java.lang.Integer instancePort
Constraints:
Range: 1 - 65535
java.lang.String sSLCertificateId
| Class com.amazonaws.services.elasticloadbalancing.model.ListenerDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Listener listener
policyNames
| Class com.amazonaws.services.elasticloadbalancing.model.ListenerNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributeNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributes extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
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.
| Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.String dNSName
java.lang.String canonicalHostedZoneName
java.lang.String canonicalHostedZoneNameID
listenerDescriptions
Policies policies
backendServerDescriptions
availabilityZones
subnets
java.lang.String vPCId
instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
securityGroups
java.util.Date createdTime
java.lang.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.
| Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
| Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
LoadBalancerAttributes data type.
| Class com.amazonaws.services.elasticloadbalancing.model.Policies extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
appCookieStickinessPolicies
lBCookieStickinessPolicies
otherPolicies
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttribute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeName
java.lang.String attributeValue
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeName
java.lang.String attributeValue
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeTypeDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String attributeName
java.lang.String attributeType
java.lang.String description
java.lang.String defaultValue
java.lang.String cardinality
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String policyName
java.lang.String policyTypeName
policyAttributeDescriptions
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeDescription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String policyTypeName
java.lang.String description
policyAttributeTypeDescriptions
| Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
instances
| Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
instances
| Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.Integer loadBalancerPort
java.lang.String sSLCertificateId
| Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.Integer instancePort
policyNames
| Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String loadBalancerName
java.lang.Integer loadBalancerPort
policyNames
| Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.elasticloadbalancing.model.SourceSecurityGroup extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String ownerAlias
--source-group-user parameter of the
ec2-authorize command in the Amazon EC2 command line
tool.
java.lang.String groupName
--source-group parameter of the
ec2-authorize command in the Amazon EC2 command line
tool.
| Class com.amazonaws.services.elasticloadbalancing.model.SubnetNotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.TooManyLoadBalancersException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.elasticloadbalancing.model.TooManyPoliciesException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Package com.amazonaws.services.s3.model |
|---|
| Class com.amazonaws.services.s3.model.AccessControlList extends java.lang.Object implements Serializable |
|---|
serialVersionUID: 8095040648034788376L
| Serialized Fields |
|---|
java.util.HashSet<E> grants
Owner owner
| Class com.amazonaws.services.s3.model.AmazonS3Exception extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 7573680383273658477L
| Serialized Fields |
|---|
java.lang.String extendedRequestId
| Class com.amazonaws.services.s3.model.MultiObjectDeleteException extends AmazonS3Exception implements Serializable |
|---|
serialVersionUID: -2004213552302446866L
| Serialized Fields |
|---|
java.util.List<E> errors
java.util.List<E> deletedObjects
| Class com.amazonaws.services.s3.model.Owner extends java.lang.Object implements Serializable |
|---|
serialVersionUID: -8916731456944569115L
| Serialized Fields |
|---|
java.lang.String displayName
java.lang.String id
| Package com.amazonaws.services.s3.transfer.exception |
|---|
| Class com.amazonaws.services.s3.transfer.exception.PauseException extends AmazonClientException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
PauseStatus status
| Package com.amazonaws.services.securitytoken.model |
|---|
| Class com.amazonaws.services.securitytoken.model.AssumedRoleUser extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String assumedRoleId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
java.lang.String arn
Constraints:
Length: 20 - 2048
| Class com.amazonaws.services.securitytoken.model.AssumeRoleRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String roleSessionName
AssumedRoleUser.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String policy
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 3600
java.lang.String externalId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
java.lang.String serialNumber
AssumeRole call. Specify this
value if the trust policy of the role being assumed includes a
condition that requires MFA authentication. The value is either the
serial number for a hardware device (such as
GAHT12345678) or an Amazon Resource Name (ARN) for a
virtual device (such as
arn:aws:iam::123456789012:mfa/user).
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String tokenCode
TokenCode value is missing or expired, the
AssumeRole call returns an "access denied" error.
Constraints:
Length: 6 - 6
Pattern: [\d]*
| Class com.amazonaws.services.securitytoken.model.AssumeRoleResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Credentials credentials
AssumedRoleUser assumedRoleUser
RoleSessionName that
you specified when you called AssumeRole.
java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
| Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String principalArn
Constraints:
Length: 20 - 2048
java.lang.String sAMLAssertion
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
Constraints:
Length: 4 - 50000
java.lang.String policy
The policy parameter is optional. If
you pass a policy, the temporary security credentials that are
returned by the operation have the permissions that are allowed by
both the access policy of the role that is being assumed,
and the policy that you pass. This gives you a way to
further restrict the permissions for the resulting temporary security
credentials. You cannot use the passed policy to grant permissions
that are in excess of those allowed by the access policy of the role
that is being assumed. For more information, see Permissions
for AssumeRoleWithSAML in Using Temporary Security
Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
NotOnOrAfter value.
The actual expiration time is whichever value is shorter.
Constraints:
Range: 900 - 129600
| Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Credentials credentials
AssumedRoleUser assumedRoleUser
java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String subject
java.lang.String subjectType
java.lang.String issuer
java.lang.String audience
java.lang.String nameQualifier
| Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String roleSessionName
AssumedRoleUser response element.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String webIdentityToken
AssumeRoleWithWebIdentity call.
Constraints:
Length: 4 - 2048
java.lang.String providerId
accounts.google.com. Do not include URL schemes and port
numbers. Currently, www.amazon.com and
graph.facebook.com are supported.
Constraints:
Length: 4 - 2048
java.lang.String policy
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
| Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Credentials credentials
java.lang.String subjectFromWebIdentityToken
WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the
application that acquired the WebIdentityToken (pairwise
identifier). If an OpenID Connect ID token was submitted in the
WebIdentityToken, this value is returned by the identity
provider as the token's sub (Subject) claim.
Constraints:
Length: 6 - 255
AssumedRoleUser assumedRoleUser
RoleSessionName that
you specified when you called AssumeRole.
java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String provider
iss
field. For OAuth 2.0 Access Tokens, this contains the value of the
ProviderId parameter that was passed in the
AssumeRoleWithWebIdentity request.
java.lang.String audience
| Class com.amazonaws.services.securitytoken.model.Credentials extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String secretAccessKey
java.lang.String sessionToken
java.util.Date expiration
| Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String encodedMessage
Constraints:
Length: 1 - 10240
| Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String decodedMessage
DecodeAuthorizationMessage.
| Class com.amazonaws.services.securitytoken.model.ExpiredTokenException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.securitytoken.model.FederatedUser extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String federatedUserId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*
java.lang.String arn
Constraints:
Length: 20 - 2048
| Class com.amazonaws.services.securitytoken.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
Bob). For
example, you can reference the federated user name in a resource-based
policy, such as in an Amazon S3 bucket policy.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String policy
GetFederationToken call and evaluated along with the
policy or policies that are attached to the IAM user whose credentials
are used to call GetFederationToken. The passed policy is
used to scope down the permissions that are available to the IAM user,
by allowing only a subset of the permissions that are granted to the
IAM user. The passed policy cannot grant more permissions than those
granted to the IAM user. The final permissions for the federated user
are the most restrictive set based on the intersection of the passed
policy and the IAM user policy. If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
| Class com.amazonaws.services.securitytoken.model.GetFederationTokenResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Credentials credentials
FederatedUser federatedUser
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob). You can use the federated user's ARN
in your resource-based policies, such as an Amazon S3 bucket policy.
java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
| Class com.amazonaws.services.securitytoken.model.GetSessionTokenRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
java.lang.String serialNumber
GetSessionToken call.
Specify this value if the IAM user has a policy that requires MFA
authentication. The value is either the serial number for a hardware
device (such as GAHT12345678) or an Amazon Resource Name
(ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user). You can find the
device for an IAM user by going to the AWS Management Console and
viewing the user's security credentials.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String tokenCode
Constraints:
Length: 6 - 6
Pattern: [\d]*
| Class com.amazonaws.services.securitytoken.model.GetSessionTokenResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Credentials credentials
| Class com.amazonaws.services.securitytoken.model.IDPCommunicationErrorException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.securitytoken.model.IDPRejectedClaimException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.securitytoken.model.InvalidAuthorizationMessageException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.securitytoken.model.InvalidIdentityTokenException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.securitytoken.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.securitytoken.model.PackedPolicyTooLargeException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Package com.amazonaws.services.simpledb.model |
|---|
| Class com.amazonaws.services.simpledb.model.Attribute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
java.lang.String alternateNameEncoding
java.lang.String value
java.lang.String alternateValueEncoding
| Class com.amazonaws.services.simpledb.model.AttributeDoesNotExistException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.BatchDeleteAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
items
| Class com.amazonaws.services.simpledb.model.BatchPutAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
items
| Class com.amazonaws.services.simpledb.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
| Class com.amazonaws.services.simpledb.model.DeletableItem extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
attributes
| Class com.amazonaws.services.simpledb.model.DeleteAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
java.lang.String itemName
attributes
UpdateCondition expected
| Class com.amazonaws.services.simpledb.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
| Class com.amazonaws.services.simpledb.model.DomainMetadataRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
| Class com.amazonaws.services.simpledb.model.DomainMetadataResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer itemCount
java.lang.Long itemNamesSizeBytes
java.lang.Integer attributeNameCount
java.lang.Long attributeNamesSizeBytes
java.lang.Integer attributeValueCount
java.lang.Long attributeValuesSizeBytes
java.lang.Integer timestamp
| Class com.amazonaws.services.simpledb.model.DuplicateItemNameException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.GetAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
java.lang.String itemName
attributeNames
java.lang.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.
| Class com.amazonaws.services.simpledb.model.GetAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
attributes
| Class com.amazonaws.services.simpledb.model.InvalidNextTokenException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.InvalidNumberPredicatesException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.InvalidNumberValueTestsException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.InvalidParameterValueException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.InvalidQueryExpressionException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.Item extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
java.lang.String alternateNameEncoding
attributes
| Class com.amazonaws.services.simpledb.model.ListDomainsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Integer maxNumberOfDomains
java.lang.String nextToken
| Class com.amazonaws.services.simpledb.model.ListDomainsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
domainNames
java.lang.String nextToken
MaxNumberOfDomains still available.
| Class com.amazonaws.services.simpledb.model.MissingParameterException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NoSuchDomainException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NumberDomainAttributesExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NumberDomainBytesExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NumberDomainsExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NumberItemAttributesExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NumberSubmittedAttributesExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.NumberSubmittedItemsExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.PutAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domainName
java.lang.String itemName
attributes
UpdateCondition expected
| Class com.amazonaws.services.simpledb.model.ReplaceableAttribute extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
java.lang.String value
java.lang.Boolean replace
false.
| Class com.amazonaws.services.simpledb.model.ReplaceableItem extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
attributes
| Class com.amazonaws.services.simpledb.model.RequestTimeoutException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.SelectRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String selectExpression
java.lang.String nextToken
ItemNames.
java.lang.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.
| Class com.amazonaws.services.simpledb.model.SelectResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
items
java.lang.String nextToken
MaxNumberOfItems were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.
| Class com.amazonaws.services.simpledb.model.TooManyRequestedAttributesException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Serialized Fields |
|---|
java.lang.Float boxUsage
| Class com.amazonaws.services.simpledb.model.UpdateCondition extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
java.lang.String value
Exists parameter is equal to true.
java.lang.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.
| Package com.amazonaws.services.simpleemail.model |
|---|
| Class com.amazonaws.services.simpleemail.model.Body extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Content text
Content html
| Class com.amazonaws.services.simpleemail.model.Content extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String data
java.lang.String charset
| Class com.amazonaws.services.simpleemail.model.DeleteIdentityRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String identity
| Class com.amazonaws.services.simpleemail.model.DeleteIdentityResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.DeleteVerifiedEmailAddressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String emailAddress
| Class com.amazonaws.services.simpleemail.model.Destination extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
toAddresses
ccAddresses
bccAddresses
| Class com.amazonaws.services.simpleemail.model.GetIdentityDkimAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
identities
| Class com.amazonaws.services.simpleemail.model.GetIdentityDkimAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> dkimAttributes
| Class com.amazonaws.services.simpleemail.model.GetIdentityNotificationAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
identities
| Class com.amazonaws.services.simpleemail.model.GetIdentityNotificationAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> notificationAttributes
| Class com.amazonaws.services.simpleemail.model.GetIdentityVerificationAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
identities
| Class com.amazonaws.services.simpleemail.model.GetIdentityVerificationAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> verificationAttributes
| Class com.amazonaws.services.simpleemail.model.GetSendQuotaRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.GetSendQuotaResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Double max24HourSend
java.lang.Double maxSendRate
java.lang.Double sentLast24Hours
| Class com.amazonaws.services.simpleemail.model.GetSendStatisticsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.GetSendStatisticsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
sendDataPoints
| Class com.amazonaws.services.simpleemail.model.IdentityDkimAttributes extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.Boolean dkimEnabled
java.lang.String dkimVerificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
dkimTokens
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
| Class com.amazonaws.services.simpleemail.model.IdentityNotificationAttributes extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String bounceTopic
java.lang.String complaintTopic
java.lang.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.
| Class com.amazonaws.services.simpleemail.model.IdentityVerificationAttributes extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String verificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
java.lang.String verificationToken
| Class com.amazonaws.services.simpleemail.model.ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String identityType
Constraints:
Allowed Values: EmailAddress, Domain
java.lang.String nextToken
java.lang.Integer maxItems
| Class com.amazonaws.services.simpleemail.model.ListIdentitiesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
identities
java.lang.String nextToken
| Class com.amazonaws.services.simpleemail.model.ListVerifiedEmailAddressesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.ListVerifiedEmailAddressesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
verifiedEmailAddresses
| Class com.amazonaws.services.simpleemail.model.Message extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
Content subject
Body body
| Class com.amazonaws.services.simpleemail.model.MessageRejectedException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.simpleemail.model.RawMessage extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.nio.ByteBuffer data
For more information, go to the Amazon SES Developer Guide.
| Class com.amazonaws.services.simpleemail.model.SendDataPoint extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Date timestamp
java.lang.Long deliveryAttempts
java.lang.Long bounces
java.lang.Long complaints
java.lang.Long rejects
| Class com.amazonaws.services.simpleemail.model.SendEmailRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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
replyToAddresses
java.lang.String returnPath
ReturnPath parameter.
| Class com.amazonaws.services.simpleemail.model.SendEmailResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String messageId
SendEmail
action.
| Class com.amazonaws.services.simpleemail.model.SendRawEmailRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
destinations
RawMessage rawMessage
| Class com.amazonaws.services.simpleemail.model.SendRawEmailResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String messageId
SendRawEmail action.
| Class com.amazonaws.services.simpleemail.model.SetIdentityDkimEnabledRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String identity
java.lang.Boolean dkimEnabled
true to enable DKIM signing for this identity;
false to disable it.
| Class com.amazonaws.services.simpleemail.model.SetIdentityDkimEnabledResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String identity
[email protected], example.com.
java.lang.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.
| Class com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.SetIdentityNotificationTopicRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String identity
[email protected], example.com.
java.lang.String notificationType
Constraints:
Allowed Values: Bounce, Complaint
java.lang.String snsTopic
| Class com.amazonaws.services.simpleemail.model.SetIdentityNotificationTopicResult extends java.lang.Object implements Serializable |
|---|
| Class com.amazonaws.services.simpleemail.model.VerifyDomainDkimRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domain
| Class com.amazonaws.services.simpleemail.model.VerifyDomainDkimResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
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.
| Class com.amazonaws.services.simpleemail.model.VerifyDomainIdentityRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String domain
| Class com.amazonaws.services.simpleemail.model.VerifyDomainIdentityResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String verificationToken
| Class com.amazonaws.services.simpleemail.model.VerifyEmailAddressRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String emailAddress
| Class com.amazonaws.services.simpleemail.model.VerifyEmailIdentityRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String emailAddress
| Class com.amazonaws.services.simpleemail.model.VerifyEmailIdentityResult extends java.lang.Object implements Serializable |
|---|
| Package com.amazonaws.services.sns.model |
|---|
| Class com.amazonaws.services.sns.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.String label
aWSAccountIds
actionNames
Valid values: any Amazon SNS action name.
| Class com.amazonaws.services.sns.model.AuthorizationErrorException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.ConfirmSubscriptionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.String token
Subscribe action.
java.lang.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.
| Class com.amazonaws.services.sns.model.ConfirmSubscriptionResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subscriptionArn
| Class com.amazonaws.services.sns.model.CreatePlatformApplicationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String name
java.lang.String platform
java.util.Map<K,V> attributes
| Class com.amazonaws.services.sns.model.CreatePlatformApplicationResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
| Class com.amazonaws.services.sns.model.CreatePlatformEndpointRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
java.lang.String token
java.lang.String customUserData
java.util.Map<K,V> attributes
| Class com.amazonaws.services.sns.model.CreatePlatformEndpointResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String endpointArn
| Class com.amazonaws.services.sns.model.CreateTopicRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.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.
| Class com.amazonaws.services.sns.model.CreateTopicResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
| Class com.amazonaws.services.sns.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String endpointArn
| Class com.amazonaws.services.sns.model.DeletePlatformApplicationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
| Class com.amazonaws.services.sns.model.DeleteTopicRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
| Class com.amazonaws.services.sns.model.Endpoint extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String endpointArn
java.util.Map<K,V> attributes
| Class com.amazonaws.services.sns.model.EndpointDisabledException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.GetEndpointAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String endpointArn
| Class com.amazonaws.services.sns.model.GetEndpointAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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.
| Class com.amazonaws.services.sns.model.GetPlatformApplicationAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
| Class com.amazonaws.services.sns.model.GetPlatformApplicationAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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.
| Class com.amazonaws.services.sns.model.GetSubscriptionAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subscriptionArn
| Class com.amazonaws.services.sns.model.GetSubscriptionAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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 defaults
| Class com.amazonaws.services.sns.model.GetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
| Class com.amazonaws.services.sns.model.GetTopicAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.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 defaults
| Class com.amazonaws.services.sns.model.InternalErrorException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.InvalidParameterException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.InvalidParameterValueException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
java.lang.String nextToken
| Class com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
endpoints
java.lang.String nextToken
| Class com.amazonaws.services.sns.model.ListPlatformApplicationsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String nextToken
| Class com.amazonaws.services.sns.model.ListPlatformApplicationsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
platformApplications
java.lang.String nextToken
| Class com.amazonaws.services.sns.model.ListSubscriptionsByTopicRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.String nextToken
ListSubscriptionsByTopic
request.
| Class com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
subscriptions
java.lang.String nextToken
ListSubscriptionsByTopic
request. This element is returned if there are more subscriptions to
retrieve.
| Class com.amazonaws.services.sns.model.ListSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String nextToken
ListSubscriptions request.
| Class com.amazonaws.services.sns.model.ListSubscriptionsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
subscriptions
java.lang.String nextToken
ListSubscriptions
request. This element is returned if there are more subscriptions to
retrieve.
| Class com.amazonaws.services.sns.model.ListTopicsRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String nextToken
ListTopics request.
| Class com.amazonaws.services.sns.model.ListTopicsResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
topics
java.lang.String nextToken
ListTopics request. This
element is returned if there are additional topics to retrieve.
| Class com.amazonaws.services.sns.model.MessageAttributeValue extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String dataType
java.lang.String stringValue
java.nio.ByteBuffer binaryValue
| Class com.amazonaws.services.sns.model.NotFoundException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.PlatformApplication extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
java.util.Map<K,V> attributes
| Class com.amazonaws.services.sns.model.PlatformApplicationDisabledException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.PublishRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.String targetArn
java.lang.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).
java.lang.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.
java.lang.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
java.util.Map<K,V> messageAttributes
| Class com.amazonaws.services.sns.model.PublishResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String messageId
Length Constraint: Maximum 100 characters
| Class com.amazonaws.services.sns.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.String label
| Class com.amazonaws.services.sns.model.SetEndpointAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String endpointArn
java.util.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.
| Class com.amazonaws.services.sns.model.SetPlatformApplicationAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String platformApplicationArn
java.util.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.
| Class com.amazonaws.services.sns.model.SetSubscriptionAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subscriptionArn
java.lang.String attributeName
Valid values:
DeliveryPolicy | RawMessageDelivery
java.lang.String attributeValue
| Class com.amazonaws.services.sns.model.SetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.String attributeName
Valid values: Policy |
DisplayName | DeliveryPolicy
java.lang.String attributeValue
| Class com.amazonaws.services.sns.model.SubscribeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
java.lang.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.
java.lang.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.
| Class com.amazonaws.services.sns.model.SubscribeResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subscriptionArn
| Class com.amazonaws.services.sns.model.Subscription extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subscriptionArn
java.lang.String owner
java.lang.String protocol
java.lang.String endpoint
java.lang.String topicArn
| Class com.amazonaws.services.sns.model.SubscriptionLimitExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.Topic extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String topicArn
| Class com.amazonaws.services.sns.model.TopicLimitExceededException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sns.model.UnsubscribeRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String subscriptionArn
| Package com.amazonaws.services.sqs.model |
|---|
| Class com.amazonaws.services.sqs.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
java.lang.String label
AliceSendMessage). Constraints: Maximum 80 characters;
alphanumeric characters, hyphens (-), and underscores (_) are allowed.
aWSAccountIds
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.
| Class com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.BatchRequestTooLongException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.BatchResultErrorEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
java.lang.Boolean senderFault
java.lang.String code
java.lang.String message
| Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
entries
| Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
Ids of a batch
request need to be unique within the request.
java.lang.String receiptHandle
java.lang.Integer visibilityTimeout
| Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
successful
failed
| Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResultEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
| Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
java.lang.String receiptHandle
java.lang.Integer visibilityTimeout
| Class com.amazonaws.services.sqs.model.CreateQueueRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueName
java.util.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.
| Class com.amazonaws.services.sqs.model.CreateQueueResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
| Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
entries
| Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
Ids of a batch
request need to be unique within the request.
java.lang.String receiptHandle
| Class com.amazonaws.services.sqs.model.DeleteMessageBatchResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
successful
failed
| Class com.amazonaws.services.sqs.model.DeleteMessageBatchResultEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
| Class com.amazonaws.services.sqs.model.DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
java.lang.String receiptHandle
| Class com.amazonaws.services.sqs.model.DeleteQueueRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
| Class com.amazonaws.services.sqs.model.EmptyBatchRequestException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.GetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
attributeNames
| Class com.amazonaws.services.sqs.model.GetQueueAttributesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.util.Map<K,V> attributes
| Class com.amazonaws.services.sqs.model.GetQueueUrlRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueName
java.lang.String queueOwnerAWSAccountId
| Class com.amazonaws.services.sqs.model.GetQueueUrlResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
| Class com.amazonaws.services.sqs.model.InvalidAttributeNameException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.InvalidBatchEntryIdException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.InvalidIdFormatException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.InvalidMessageContentsException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
| Class com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
queueUrls
| Class com.amazonaws.services.sqs.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueNamePrefix
| Class com.amazonaws.services.sqs.model.ListQueuesResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
queueUrls
| Class com.amazonaws.services.sqs.model.Message extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String messageId
java.lang.String receiptHandle
java.lang.String mD5OfBody
java.lang.String body
java.util.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.
java.lang.String mD5OfMessageAttributes
java.util.Map<K,V> messageAttributes
| Class com.amazonaws.services.sqs.model.MessageAttributeValue extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String stringValue
java.nio.ByteBuffer binaryValue
stringListValues
binaryListValues
java.lang.String dataType
| Class com.amazonaws.services.sqs.model.MessageNotInflightException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.OverLimitException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.QueueDeletedRecentlyException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.QueueDoesNotExistException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.QueueNameExistsException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.ReceiveMessageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
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).
messageAttributeNames
java.lang.Integer maxNumberOfMessages
All of the messages are not necessarily returned.
java.lang.Integer visibilityTimeout
ReceiveMessage request.
java.lang.Integer waitTimeSeconds
| Class com.amazonaws.services.sqs.model.ReceiveMessageResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
messages
| Class com.amazonaws.services.sqs.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
java.lang.String label
| Class com.amazonaws.services.sqs.model.SendMessageBatchRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
entries
| Class com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
Ids of a batch
request need to be unique within the request.
java.lang.String messageBody
java.lang.Integer delaySeconds
java.util.Map<K,V> messageAttributes
| Class com.amazonaws.services.sqs.model.SendMessageBatchResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
successful
failed
| Class com.amazonaws.services.sqs.model.SendMessageBatchResultEntry extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String id
java.lang.String messageId
java.lang.String mD5OfMessageBody
java.lang.String mD5OfMessageAttributes
| Class com.amazonaws.services.sqs.model.SendMessageRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
java.lang.String messageBody
java.lang.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.
java.util.Map<K,V> messageAttributes
| Class com.amazonaws.services.sqs.model.SendMessageResult extends java.lang.Object implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String mD5OfMessageBody
java.lang.String mD5OfMessageAttributes
java.lang.String messageId
| Class com.amazonaws.services.sqs.model.SetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable |
|---|
| Serialized Fields |
|---|
java.lang.String queueUrl
java.util.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.
| Class com.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Class com.amazonaws.services.sqs.model.UnsupportedOperationException extends AmazonServiceException implements Serializable |
|---|
serialVersionUID: 1L
| Package com.amazonaws.util.json |
|---|
| Class com.amazonaws.util.json.JSONException extends java.lang.Exception implements Serializable |
|---|
serialVersionUID: 0L
| Serialized Fields |
|---|
java.lang.Throwable cause
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||